---

Input index	Input details	Output index	Output details

---

pcmOpCustModifyCustomer

	Component		fm_cust
	Visibility		public
	Transaction		required

---

Description

The pcmOpCustModifyCustomer operation can be used to modify customer information. This operations helps to add account and service level deals, add new services and purchase deals to those services and also to add and/or update balance groups, billinfo's, payinfo's and profiles.

---

Input field index

0		poid	POID
0		poid	ACCOUNT_OBJ
0		timestamp	END_T
0		timestamp	START_T
0		string	PROGRAM_NAME
0		array	ACCTINFO
1		poid	DEAL_OBJ
1		substruct	DEAL_INFO
2		string	NAME
2		string	DESCR
2		timestamp	START_T
2		timestamp	END_T
2		int	FLAGS
2		array	PRODUCTS
3		poid	PRODUCT_OBJ
3		poid	PLAN_OBJ
3		decimal	QUANTITY
3		enum	STATUS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		decimal	PURCHASE_DISCOUNT
3		decimal	PURCHASE_DISC_AMT
3		decimal	PURCHASE_FEE_AMT
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		decimal	CYCLE_DISCOUNT
3		decimal	CYCLE_DISC_AMT
3		decimal	CYCLE_FEE_AMT
3		int	STATUS_FLAGS
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		decimal	USAGE_DISCOUNT
3		string	DESCR
3		string	PRICE_LIST_NAME
2		array	DISCOUNTS
3		poid	DISCOUNT_OBJ
3		poid	PLAN_OBJ
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		string	DESCR
2		array	PERMITTEDS
3		string	OBJ_TYPE
1		array	BAL_INFO
2		poid	POID
2		string	NAME
2		array	BILLINFO
3		poid	POID
3		poid	BUSINESS_PROFILE_OBJ
3		string	BILLINFO_ID
3		array	PAYINFO
4		poid	POID
4		enum	PAY_TYPE
4		enum	PAYMENT_TERM
4		int	PAYMENT_OFFSET
4		string	NAME
4		enum	INV_TYPE
4		int	FLAGS
4		substruct	INHERITED_INFO
5		array	INV_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DELIVERY_DESCR
6		enum	DELIVERY_PREFER
6		string	INV_INSTR
6		enum	INV_TERMS
6		string	EMAIL_ADDR
6		string	NAME
6		string	STATE
6		string	ZIP
5		array	CC_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_EXP
6		string	DEBIT_NUM
6		string	NAME
6		string	SECURITY_ID
6		string	STATE
6		string	ZIP
5		array	DD_INFO
6		string	ADDRESS
6		string	BANK_NO
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_NUM
6		string	NAME
6		string	STATE
6		enum	TYPE
6		string	ZIP
5		array	SEPA_INFO
6		enum	MANDATE_TYPE
6		string	IBAN
6		string	BIC
6		string	MANDATE_CONTRACT_ID
6		string	MANDATE_CONTRACT_DESCR
6		string	MANDATE_UNIQUE_REFERENCE
6		timestamp	MANDATE_SIGNED_T
6		string	MANDATE_SIGNED_PLACE
6		array	DEBTOR_INFO
7		string	ADDRESS
7		string	CITY
7		string	COUNTRY
7		string	NAME
7		string	ZIP
7		string	IDENTIFICATION_CODE
7		string	REF_PARTY
7		string	REF_PARTY_ID_CODE
6		string	CREDITOR_ID
6		string	CREDITOR_NAME
3		array	BAL_INFO
3		enum	PAY_TYPE
3		int	PARENT_FLAGS
3		int	BILL_WHEN
3		int	ACTG_FUTURE_DOM
3		enum	ACTG_TYPE
3		enum	BILLING_STATUS
3		int	BILLING_STATUS_FLAGS
3		enum	STATUS
3		int	STATUS_FLAGS
3		int	SPONSOR_FLAGS
3		int	SPONSOREE_FLAGS
3		poid	AR_BILLINFO_OBJ
3		poid	PARENT_BILLINFO_OBJ
3		int	CURRENCY
3		int	CURRENCY_SECONDARY
3		enum	BILLING_SEGMENT
2		poid	BILLINFO_OBJ
2		array	LIMIT
3		decimal	CREDIT_LIMIT
3		decimal	CREDIT_FLOOR
3		decimal	CREDIT_THRESHOLDS_FIXED
3		int	CREDIT_THRESHOLDS
3		array	THRESHOLDS
4		int	THRESHOLD
4		decimal	AMOUNT
2		array	RULES
3		enum	CONSUMPTION_RULE
1		poid	BAL_GRP_OBJ
1		int	CURRENCY
1		int	CURRENCY_SECONDARY
0		array	SERVICES
1		poid	SERVICE_OBJ
1		int	SUBSCRIPTION_INDEX
1		poid	SUBSCRIPTION_OBJ
1		string	SERVICE_ID
1		array	BAL_INFO
2		poid	POID
2		string	NAME
2		array	BILLINFO
3		poid	POID
3		poid	BUSINESS_PROFILE_OBJ
3		string	BILLINFO_ID
3		array	PAYINFO
4		poid	POID
4		enum	PAY_TYPE
4		enum	PAYMENT_TERM
4		int	PAYMENT_OFFSET
4		string	NAME
4		enum	INV_TYPE
4		int	FLAGS
4		substruct	INHERITED_INFO
5		array	INV_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DELIVERY_DESCR
6		enum	DELIVERY_PREFER
6		string	INV_INSTR
6		enum	INV_TERMS
6		string	EMAIL_ADDR
6		string	NAME
6		string	STATE
6		string	ZIP
5		array	CC_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_EXP
6		string	DEBIT_NUM
6		string	NAME
6		string	SECURITY_ID
6		string	STATE
6		string	ZIP
5		array	DD_INFO
6		string	ADDRESS
6		string	BANK_NO
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_NUM
6		string	NAME
6		string	STATE
6		enum	TYPE
6		string	ZIP
5		array	SEPA_INFO
6		enum	MANDATE_TYPE
6		string	IBAN
6		string	BIC
6		string	MANDATE_CONTRACT_ID
6		string	MANDATE_CONTRACT_DESCR
6		string	MANDATE_UNIQUE_REFERENCE
6		timestamp	MANDATE_SIGNED_T
6		string	MANDATE_SIGNED_PLACE
6		array	DEBTOR_INFO
7		string	ADDRESS
7		string	CITY
7		string	COUNTRY
7		string	NAME
7		string	ZIP
7		string	IDENTIFICATION_CODE
7		string	REF_PARTY
7		string	REF_PARTY_ID_CODE
6		string	CREDITOR_ID
6		string	CREDITOR_NAME
3		array	BAL_INFO
3		enum	PAY_TYPE
3		int	PARENT_FLAGS
3		int	BILL_WHEN
3		int	ACTG_FUTURE_DOM
3		enum	ACTG_TYPE
3		enum	BILLING_STATUS
3		int	BILLING_STATUS_FLAGS
3		enum	STATUS
3		int	STATUS_FLAGS
3		int	SPONSOR_FLAGS
3		int	SPONSOREE_FLAGS
3		poid	AR_BILLINFO_OBJ
3		poid	PARENT_BILLINFO_OBJ
3		int	CURRENCY
3		int	CURRENCY_SECONDARY
3		enum	BILLING_SEGMENT
2		poid	BILLINFO_OBJ
2		array	LIMIT
3		decimal	CREDIT_LIMIT
3		decimal	CREDIT_FLOOR
3		decimal	CREDIT_THRESHOLDS_FIXED
3		int	CREDIT_THRESHOLDS
3		array	THRESHOLDS
4		int	THRESHOLD
4		decimal	AMOUNT
2		array	RULES
3		enum	CONSUMPTION_RULE
1		poid	BAL_GRP_OBJ
1		string	LOGIN
1		array	ALIAS_LIST
2		string	NAME
1		string	PASSWD_CLEAR
1		enum	PASSWD_STATUS
1		poid	DEAL_OBJ
1		substruct	DEAL_INFO
2		string	NAME
2		string	DESCR
2		timestamp	START_T
2		timestamp	END_T
2		int	FLAGS
2		array	PRODUCTS
3		poid	PRODUCT_OBJ
3		poid	PLAN_OBJ
3		decimal	QUANTITY
3		enum	STATUS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		decimal	PURCHASE_DISCOUNT
3		decimal	PURCHASE_DISC_AMT
3		decimal	PURCHASE_FEE_AMT
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		decimal	CYCLE_DISCOUNT
3		decimal	CYCLE_DISC_AMT
3		decimal	CYCLE_FEE_AMT
3		int	STATUS_FLAGS
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		decimal	USAGE_DISCOUNT
3		string	DESCR
3		string	PRICE_LIST_NAME
2		array	DISCOUNTS
3		poid	DISCOUNT_OBJ
3		poid	PLAN_OBJ
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		string	DESCR
2		array	PERMITTEDS
3		string	OBJ_TYPE
1		array	DEALS
2		poid	DEAL_OBJ
2		enum	TYPE
2		substruct	DEAL_INFO
3		string	NAME
3		string	DESCR
3		timestamp	START_T
3		timestamp	END_T
3		int	FLAGS
3		array	PRODUCTS
4		poid	PRODUCT_OBJ
4		poid	PLAN_OBJ
4		decimal	QUANTITY
4		enum	STATUS
4		timestamp	PURCHASE_START_T
4		int	PURCHASE_START_UNIT
4		int	PURCHASE_START_OFFSET
4		timestamp	PURCHASE_END_T
4		int	PURCHASE_END_UNIT
4		int	PURCHASE_END_OFFSET
4		decimal	PURCHASE_DISCOUNT
4		decimal	PURCHASE_DISC_AMT
4		decimal	PURCHASE_FEE_AMT
4		timestamp	CYCLE_START_T
4		int	CYCLE_START_UNIT
4		int	CYCLE_START_OFFSET
4		timestamp	CYCLE_END_T
4		int	CYCLE_END_UNIT
4		int	CYCLE_END_OFFSET
4		decimal	CYCLE_DISCOUNT
4		decimal	CYCLE_DISC_AMT
4		decimal	CYCLE_FEE_AMT
4		int	STATUS_FLAGS
4		timestamp	USAGE_START_T
4		int	USAGE_START_UNIT
4		int	USAGE_START_OFFSET
4		timestamp	USAGE_END_T
4		int	USAGE_END_UNIT
4		int	USAGE_END_OFFSET
4		decimal	USAGE_DISCOUNT
4		string	DESCR
3		array	DISCOUNTS
4		poid	DISCOUNT_OBJ
4		poid	PLAN_OBJ
4		decimal	QUANTITY
4		enum	STATUS
4		int	STATUS_FLAGS
4		timestamp	PURCHASE_START_T
4		int	PURCHASE_START_UNIT
4		int	PURCHASE_START_OFFSET
4		timestamp	PURCHASE_END_T
4		int	PURCHASE_END_UNIT
4		int	PURCHASE_END_OFFSET
4		timestamp	CYCLE_START_T
4		int	CYCLE_START_UNIT
4		int	CYCLE_START_OFFSET
4		timestamp	CYCLE_END_T
4		int	CYCLE_END_UNIT
4		int	CYCLE_END_OFFSET
4		timestamp	USAGE_START_T
4		int	USAGE_START_UNIT
4		int	USAGE_START_OFFSET
4		timestamp	USAGE_END_T
4		int	USAGE_END_UNIT
4		int	USAGE_END_OFFSET
4		string	DESCR
3		array	PERMITTEDS
4		string	OBJ_TYPE
1		array	STATUSES
2		enum	STATUS
2		int	STATUS_FLAGS
2		timestamp	CLOSE_WHEN_T
1		array	PROFILES
2		poid	PROFILE_OBJ
2		substruct	INHERITED_INFO
1		substruct	INHERITED_INFO
1		array	DEVICES
2		poid	DEVICE_OBJ
0		array	BILLINFO
1		poid	POID
1		poid	BUSINESS_PROFILE_OBJ
1		string	BILLINFO_ID
1		int	ACTG_CYCLE_DOM
1		array	PAYINFO
2		poid	POID
2		enum	PAY_TYPE
2		enum	PAYMENT_TERM
2		int	PAYMENT_OFFSET
2		string	NAME
2		enum	INV_TYPE
2		int	FLAGS
2		substruct	INHERITED_INFO
3		array	INV_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DELIVERY_DESCR
4		enum	DELIVERY_PREFER
4		string	INV_INSTR
4		enum	INV_TERMS
4		string	EMAIL_ADDR
4		string	NAME
4		string	STATE
4		string	ZIP
3		array	CC_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_EXP
4		string	DEBIT_NUM
4		string	NAME
4		string	SECURITY_ID
4		string	STATE
4		string	ZIP
3		array	DD_INFO
4		string	ADDRESS
4		string	BANK_NO
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_NUM
4		string	NAME
4		string	STATE
4		enum	TYPE
4		string	ZIP
3		array	SEPA_INFO
4		enum	MANDATE_TYPE
4		string	IBAN
4		string	BIC
4		string	MANDATE_CONTRACT_ID
4		string	MANDATE_CONTRACT_DESCR
4		string	MANDATE_UNIQUE_REFERENCE
4		timestamp	MANDATE_SIGNED_T
4		string	MANDATE_SIGNED_PLACE
4		array	DEBTOR_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	NAME
5		string	ZIP
5		string	IDENTIFICATION_CODE
5		string	REF_PARTY
5		string	REF_PARTY_ID_CODE
4		string	CREDITOR_ID
4		string	CREDITOR_NAME
1		array	BAL_INFO
2		poid	POID
2		string	NAME
2		array	BILLINFO
2		poid	BILLINFO_OBJ
2		array	LIMIT
3		decimal	CREDIT_LIMIT
3		decimal	CREDIT_FLOOR
3		decimal	CREDIT_THRESHOLDS_FIXED
3		int	CREDIT_THRESHOLDS
3		array	THRESHOLDS
4		int	THRESHOLD
4		decimal	AMOUNT
2		array	RULES
3		enum	CONSUMPTION_RULE
1		poid	PAYINFO_OBJ
1		poid	BAL_GRP_OBJ
1		enum	PAY_TYPE
1		int	PARENT_FLAGS
1		int	BILL_WHEN
1		int	ACTG_FUTURE_DOM
1		enum	ACTG_TYPE
1		enum	BILLING_STATUS
1		int	BILLING_STATUS_FLAGS
1		enum	STATUS
1		int	STATUS_FLAGS
1		int	SPONSOR_FLAGS
1		int	SPONSOREE_FLAGS
1		poid	AR_BILLINFO_OBJ
1		poid	PARENT_BILLINFO_OBJ
1		int	CURRENCY
1		int	CURRENCY_SECONDARY
1		enum	BILLING_SEGMENT
0		array	BAL_INFO
1		poid	POID
1		string	NAME
1		array	BILLINFO
2		poid	POID
2		poid	BUSINESS_PROFILE_OBJ
2		string	BILLINFO_ID
2		array	PAYINFO
3		poid	POID
3		enum	PAY_TYPE
3		enum	PAYMENT_TERM
3		int	PAYMENT_OFFSET
3		string	NAME
3		enum	INV_TYPE
3		int	FLAGS
3		substruct	INHERITED_INFO
4		array	INV_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DELIVERY_DESCR
5		enum	DELIVERY_PREFER
5		string	INV_INSTR
5		enum	INV_TERMS
5		string	EMAIL_ADDR
5		string	NAME
5		string	STATE
5		string	ZIP
4		array	CC_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_EXP
5		string	DEBIT_NUM
5		string	NAME
5		string	SECURITY_ID
5		string	STATE
5		string	ZIP
4		array	DD_INFO
5		string	ADDRESS
5		string	BANK_NO
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_NUM
5		string	NAME
5		string	STATE
5		enum	TYPE
5		string	ZIP
4		array	SEPA_INFO
5		enum	MANDATE_TYPE
5		string	IBAN
5		string	BIC
5		string	MANDATE_CONTRACT_ID
5		string	MANDATE_CONTRACT_DESCR
5		string	MANDATE_UNIQUE_REFERENCE
5		timestamp	MANDATE_SIGNED_T
5		string	MANDATE_SIGNED_PLACE
5		array	DEBTOR_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	NAME
6		string	ZIP
6		string	IDENTIFICATION_CODE
6		string	REF_PARTY
6		string	REF_PARTY_ID_CODE
5		string	CREDITOR_ID
5		string	CREDITOR_NAME
2		array	BAL_INFO
2		enum	PAY_TYPE
2		int	PARENT_FLAGS
2		int	BILL_WHEN
2		int	ACTG_FUTURE_DOM
2		enum	ACTG_TYPE
2		enum	BILLING_STATUS
2		int	BILLING_STATUS_FLAGS
2		enum	STATUS
2		int	STATUS_FLAGS
2		int	SPONSOR_FLAGS
2		int	SPONSOREE_FLAGS
2		poid	AR_BILLINFO_OBJ
2		poid	PARENT_BILLINFO_OBJ
2		int	CURRENCY
2		int	CURRENCY_SECONDARY
2		enum	BILLING_SEGMENT
1		poid	BILLINFO_OBJ
1		array	LIMIT
2		decimal	CREDIT_LIMIT
2		decimal	CREDIT_FLOOR
2		int	CREDIT_THRESHOLDS
2		array	THRESHOLDS
3		int	THRESHOLD
3		decimal	AMOUNT
1		array	RULES
2		enum	CONSUMPTION_RULE
0		array	PAYINFO
1		poid	POID
1		enum	PAY_TYPE
1		enum	PAYMENT_TERM
1		int	PAYMENT_OFFSET
1		enum	INV_TYPE
1		int	FLAGS
1		substruct	INHERITED_INFO
2		array	INV_INFO
3		string	ADDRESS
3		string	CITY
3		string	COUNTRY
3		string	DELIVERY_DESCR
3		enum	DELIVERY_PREFER
3		string	INV_INSTR
3		enum	INV_TERMS
3		string	EMAIL_ADDR
3		string	NAME
3		string	STATE
3		string	ZIP
2		array	CC_INFO
3		string	ADDRESS
3		string	CITY
3		string	COUNTRY
3		string	DEBIT_EXP
3		string	DEBIT_NUM
3		string	NAME
3		string	SECURITY_ID
3		string	STATE
3		string	ZIP
2		array	DD_INFO
3		string	ADDRESS
3		string	BANK_NO
3		string	CITY
3		string	COUNTRY
3		string	DEBIT_NUM
3		string	NAME
3		string	STATE
3		enum	TYPE
3		string	ZIP
2		array	SEPA_INFO
3		enum	MANDATE_TYPE
3		string	IBAN
3		string	BIC
3		string	MANDATE_CONTRACT_ID
3		string	MANDATE_CONTRACT_DESCR
3		string	MANDATE_UNIQUE_REFERENCE
3		array	DEBTOR_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	NAME
4		string	ZIP
4		string	IDENTIFICATION_CODE
4		string	REF_PARTY
4		string	REF_PARTY_ID_CODE
3		string	CREDITOR_ID
3		string	CREDITOR_NAME
0		array	PROFILES
1		poid	PROFILE_OBJ
1		substruct	INHERITED_INFO
0		array	TOPUP_INFO
1		poid	POID
1		poid	ACCOUNT_OBJ
1		array	PAYINFO
2		poid	POID
2		enum	PAY_TYPE
2		enum	PAYMENT_TERM
2		int	PAYMENT_OFFSET
2		string	NAME
2		enum	INV_TYPE
2		int	FLAGS
2		substruct	INHERITED_INFO
3		array	INV_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DELIVERY_DESCR
4		enum	DELIVERY_PREFER
4		string	INV_INSTR
4		enum	INV_TERMS
4		string	EMAIL_ADDR
4		string	NAME
4		string	STATE
4		string	ZIP
3		array	CC_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_EXP
4		string	DEBIT_NUM
4		string	NAME
4		string	SECURITY_ID
4		string	STATE
4		string	ZIP
3		array	DD_INFO
4		string	ADDRESS
4		string	BANK_NO
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_NUM
4		string	NAME
4		string	STATE
4		enum	TYPE
4		string	ZIP
3		array	SEPA_INFO
4		enum	MANDATE_TYPE
4		string	IBAN
4		string	BIC
4		string	MANDATE_CONTRACT_ID
4		string	MANDATE_CONTRACT_DESCR
4		string	MANDATE_UNIQUE_REFERENCE
4		timestamp	MANDATE_SIGNED_T
4		string	MANDATE_SIGNED_PLACE
4		array	DEBTOR_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	NAME
5		string	ZIP
5		string	IDENTIFICATION_CODE
5		string	REF_PARTY
5		string	REF_PARTY_ID_CODE
4		string	CREDITOR_ID
4		string	CREDITOR_NAME
1		poid	PAYINFO_OBJ
1		array	BILLINFO
2		poid	POID
2		poid	BUSINESS_PROFILE_OBJ
2		string	BILLINFO_ID
2		array	PAYINFO
3		poid	POID
3		enum	PAY_TYPE
3		enum	PAYMENT_TERM
3		int	PAYMENT_OFFSET
3		string	NAME
3		enum	INV_TYPE
3		int	FLAGS
3		substruct	INHERITED_INFO
4		array	INV_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DELIVERY_DESCR
5		enum	DELIVERY_PREFER
5		string	INV_INSTR
5		enum	INV_TERMS
5		string	EMAIL_ADDR
5		string	NAME
5		string	STATE
5		string	ZIP
4		array	CC_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_EXP
5		string	DEBIT_NUM
5		string	NAME
5		string	SECURITY_ID
5		string	STATE
5		string	ZIP
4		array	DD_INFO
5		string	ADDRESS
5		string	BANK_NO
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_NUM
5		string	NAME
5		string	STATE
5		enum	TYPE
5		string	ZIP
4		array	SEPA_INFO
5		enum	MANDATE_TYPE
5		string	IBAN
5		string	BIC
5		string	MANDATE_CONTRACT_ID
5		string	MANDATE_CONTRACT_DESCR
5		string	MANDATE_UNIQUE_REFERENCE
5		timestamp	MANDATE_SIGNED_T
5		string	MANDATE_SIGNED_PLACE
5		array	DEBTOR_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	NAME
6		string	ZIP
6		string	IDENTIFICATION_CODE
6		string	REF_PARTY
6		string	REF_PARTY_ID_CODE
5		string	CREDITOR_ID
5		string	CREDITOR_NAME
2		array	BAL_INFO
3		poid	POID
3		string	NAME
3		array	BILLINFO
3		poid	BILLINFO_OBJ
3		array	LIMIT
4		decimal	CREDIT_LIMIT
4		decimal	CREDIT_FLOOR
4		decimal	CREDIT_THRESHOLDS_FIXED
4		int	CREDIT_THRESHOLDS
4		array	THRESHOLDS
5		int	THRESHOLD
5		decimal	AMOUNT
3		array	RULES
4		enum	CONSUMPTION_RULE
2		enum	PAY_TYPE
2		int	PARENT_FLAGS
2		int	BILL_WHEN
2		int	ACTG_FUTURE_DOM
2		enum	ACTG_TYPE
2		enum	BILLING_STATUS
2		int	BILLING_STATUS_FLAGS
2		enum	STATUS
2		int	STATUS_FLAGS
2		int	SPONSOR_FLAGS
2		int	SPONSOREE_FLAGS
2		poid	AR_BILLINFO_OBJ
2		poid	PARENT_BILLINFO_OBJ
2		int	CURRENCY
2		int	CURRENCY_SECONDARY
2		enum	BILLING_SEGMENT
1		poid	BILLINFO_OBJ
1		decimal	TOPUP_AMT
1		decimal	TOPUP_CAP
1		decimal	CYCLE_TOPPED_AMT
1		timestamp	LAST_TOPUP_T
1		array	GROUP_TOPUP_INFO
2		poid	POID
2		poid	PARENT
2		string	NAME
2		poid	BAL_GRP_OBJ
2		array	GROUP_TOPUP_LIMITS
3		int	RESOURCE_ID
3		decimal	TOPUP_AMT
3		decimal	TOPUP_CAP
2		array	GROUP_TOPUP_MEMBERS
3		poid	BAL_GRP_OBJ
3		int	TOPUP_INTERVAL
3		string	PIN
3		enum	STATUS
0		substruct	CONTEXT_INFO
1		string	CORRELATION_ID
1		string	EXTERNAL_USER

---

Output field index

0		poid	POID
0		poid	ACCOUNT_OBJ
0		timestamp	END_T
0		timestamp	START_T
0		string	PROGRAM_NAME
0		array	ACCTINFO
1		poid	POID
1		poid	DEAL_OBJ
1		substruct	DEAL_INFO
2		string	NAME
2		string	DESCR
2		timestamp	START_T
2		timestamp	END_T
2		int	FLAGS
2		array	PRODUCTS
3		poid	PRODUCT_OBJ
3		poid	PLAN_OBJ
3		poid	OFFERING_OBJ
3		int	PACKAGE_ID
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		decimal	PURCHASE_DISCOUNT
3		decimal	PURCHASE_DISC_AMT
3		decimal	PURCHASE_FEE_AMT
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		decimal	CYCLE_DISCOUNT
3		decimal	CYCLE_DISC_AMT
3		decimal	CYCLE_FEE_AMT
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		decimal	USAGE_DISCOUNT
3		string	DESCR
3		string	PRICE_LIST_NAME
2		array	DISCOUNTS
3		poid	DISCOUNT_OBJ
3		poid	PLAN_OBJ
3		poid	OFFERING_OBJ
3		int	PACKAGE_ID
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		string	DESCR
2		array	PERMITTEDS
3		string	OBJ_TYPE
1		array	BAL_INFO
2		poid	POID
2		string	NAME
2		array	BILLINFO
3		poid	POID
3		poid	BUSINESS_PROFILE_OBJ
3		string	BILLINFO_ID
3		array	PAYINFO
4		poid	POID
4		enum	PAY_TYPE
4		enum	PAYMENT_TERM
4		int	PAYMENT_OFFSET
4		string	NAME
4		enum	INV_TYPE
4		int	FLAGS
4		substruct	INHERITED_INFO
5		array	INV_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DELIVERY_DESCR
6		enum	DELIVERY_PREFER
6		string	INV_INSTR
6		enum	INV_TERMS
6		string	EMAIL_ADDR
6		string	NAME
6		string	STATE
6		string	ZIP
5		array	CC_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_EXP
6		string	DEBIT_NUM
6		string	NAME
6		string	SECURITY_ID
6		string	STATE
6		string	ZIP
5		array	DD_INFO
6		string	ADDRESS
6		string	BANK_NO
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_NUM
6		string	NAME
6		string	STATE
6		enum	TYPE
6		string	ZIP
5		array	SEPA_INFO
6		enum	MANDATE_TYPE
6		string	IBAN
6		string	BIC
6		string	MANDATE_CONTRACT_ID
6		string	MANDATE_CONTRACT_DESCR
6		string	MANDATE_UNIQUE_REFERENCE
6		timestamp	MANDATE_SIGNED_T
6		string	MANDATE_SIGNED_PLACE
6		array	DEBTOR_INFO
7		string	ADDRESS
7		string	CITY
7		string	COUNTRY
7		string	NAME
7		string	ZIP
7		string	IDENTIFICATION_CODE
7		string	REF_PARTY
7		string	REF_PARTY_ID_CODE
6		string	CREDITOR_ID
6		string	CREDITOR_NAME
3		array	BAL_INFO
3		enum	PAY_TYPE
3		int	PARENT_FLAGS
3		int	BILL_WHEN
3		int	ACTG_FUTURE_DOM
3		enum	ACTG_TYPE
3		enum	BILLING_STATUS
3		int	BILLING_STATUS_FLAGS
3		enum	STATUS
3		int	STATUS_FLAGS
3		int	SPONSOR_FLAGS
3		int	SPONSOREE_FLAGS
3		poid	AR_BILLINFO_OBJ
3		poid	PARENT_BILLINFO_OBJ
3		int	CURRENCY
3		int	CURRENCY_SECONDARY
3		enum	BILLING_SEGMENT
2		poid	BILLINFO_OBJ
2		array	LIMIT
3		decimal	CREDIT_LIMIT
3		decimal	CREDIT_FLOOR
3		decimal	CREDIT_THRESHOLDS_FIXED
3		int	CREDIT_THRESHOLDS
3		array	THRESHOLDS
4		int	THRESHOLD
4		decimal	AMOUNT
2		array	RULES
3		enum	CONSUMPTION_RULE
1		poid	BAL_GRP_OBJ
1		int	CURRENCY
1		int	CURRENCY_SECONDARY
0		array	SERVICES
1		poid	SERVICE_OBJ
1		int	SUBSCRIPTION_INDEX
1		poid	SUBSCRIPTION_OBJ
1		poid	BILLINFO_OBJ
1		string	SERVICE_ID
1		array	BAL_INFO
2		poid	POID
2		string	NAME
2		array	BILLINFO
3		poid	POID
3		poid	BUSINESS_PROFILE_OBJ
3		string	BILLINFO_ID
3		array	PAYINFO
4		poid	POID
4		enum	PAY_TYPE
4		enum	PAYMENT_TERM
4		int	PAYMENT_OFFSET
4		string	NAME
4		enum	INV_TYPE
4		int	FLAGS
4		substruct	INHERITED_INFO
5		array	INV_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DELIVERY_DESCR
6		enum	DELIVERY_PREFER
6		string	INV_INSTR
6		enum	INV_TERMS
6		string	EMAIL_ADDR
6		string	NAME
6		string	STATE
6		string	ZIP
5		array	CC_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_EXP
6		string	DEBIT_NUM
6		string	NAME
6		string	SECURITY_ID
6		string	STATE
6		string	ZIP
5		array	DD_INFO
6		string	ADDRESS
6		string	BANK_NO
6		string	CITY
6		string	COUNTRY
6		string	DEBIT_NUM
6		string	NAME
6		string	STATE
6		enum	TYPE
6		string	ZIP
5		array	SEPA_INFO
6		enum	MANDATE_TYPE
6		string	IBAN
6		string	BIC
6		string	MANDATE_CONTRACT_ID
6		string	MANDATE_CONTRACT_DESCR
6		string	MANDATE_UNIQUE_REFERENCE
6		timestamp	MANDATE_SIGNED_T
6		string	MANDATE_SIGNED_PLACE
6		array	DEBTOR_INFO
7		string	ADDRESS
7		string	CITY
7		string	COUNTRY
7		string	NAME
7		string	ZIP
7		string	IDENTIFICATION_CODE
7		string	REF_PARTY
7		string	REF_PARTY_ID_CODE
6		string	CREDITOR_ID
6		string	CREDITOR_NAME
3		array	BAL_INFO
3		enum	PAY_TYPE
3		int	PARENT_FLAGS
3		int	BILL_WHEN
3		int	ACTG_FUTURE_DOM
3		enum	ACTG_TYPE
3		enum	BILLING_STATUS
3		int	BILLING_STATUS_FLAGS
3		enum	STATUS
3		int	STATUS_FLAGS
3		int	SPONSOR_FLAGS
3		int	SPONSOREE_FLAGS
3		poid	AR_BILLINFO_OBJ
3		poid	PARENT_BILLINFO_OBJ
3		int	CURRENCY
3		int	CURRENCY_SECONDARY
3		enum	BILLING_SEGMENT
2		poid	BILLINFO_OBJ
2		array	LIMIT
3		decimal	CREDIT_LIMIT
3		decimal	CREDIT_FLOOR
3		decimal	CREDIT_THRESHOLDS_FIXED
3		int	CREDIT_THRESHOLDS
3		array	THRESHOLDS
4		int	THRESHOLD
4		decimal	AMOUNT
2		array	RULES
3		enum	CONSUMPTION_RULE
1		poid	BAL_GRP_OBJ
1		string	LOGIN
1		array	ALIAS_LIST
2		string	NAME
1		enum	PASSWD_STATUS
1		poid	DEAL_OBJ
1		substruct	DEAL_INFO
2		string	NAME
2		string	DESCR
2		timestamp	START_T
2		timestamp	END_T
2		int	FLAGS
2		array	PRODUCTS
3		poid	PRODUCT_OBJ
3		poid	PLAN_OBJ
3		poid	OFFERING_OBJ
3		int	PACKAGE_ID
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		decimal	PURCHASE_DISCOUNT
3		decimal	PURCHASE_DISC_AMT
3		decimal	PURCHASE_FEE_AMT
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		decimal	CYCLE_DISCOUNT
3		decimal	CYCLE_DISC_AMT
3		decimal	CYCLE_FEE_AMT
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		decimal	USAGE_DISCOUNT
3		string	DESCR
3		string	PRICE_LIST_NAME
2		array	DISCOUNTS
3		poid	DISCOUNT_OBJ
3		poid	PLAN_OBJ
3		poid	OFFERING_OBJ
3		int	PACKAGE_ID
3		decimal	QUANTITY
3		enum	STATUS
3		int	STATUS_FLAGS
3		timestamp	PURCHASE_START_T
3		int	PURCHASE_START_UNIT
3		int	PURCHASE_START_OFFSET
3		timestamp	PURCHASE_END_T
3		int	PURCHASE_END_UNIT
3		int	PURCHASE_END_OFFSET
3		timestamp	CYCLE_START_T
3		int	CYCLE_START_UNIT
3		int	CYCLE_START_OFFSET
3		timestamp	CYCLE_END_T
3		int	CYCLE_END_UNIT
3		int	CYCLE_END_OFFSET
3		timestamp	USAGE_START_T
3		int	USAGE_START_UNIT
3		int	USAGE_START_OFFSET
3		timestamp	USAGE_END_T
3		int	USAGE_END_UNIT
3		int	USAGE_END_OFFSET
3		string	DESCR
2		array	PERMITTEDS
3		string	OBJ_TYPE
1		array	DEALS
2		poid	DEAL_OBJ
2		enum	TYPE
2		substruct	DEAL_INFO
3		string	NAME
3		string	DESCR
3		timestamp	START_T
3		timestamp	END_T
3		int	FLAGS
3		array	PRODUCTS
4		poid	PRODUCT_OBJ
4		poid	PLAN_OBJ
4		poid	OFFERING_OBJ
4		int	PACKAGE_ID
4		decimal	QUANTITY
4		enum	STATUS
4		int	STATUS_FLAGS
4		timestamp	PURCHASE_START_T
4		int	PURCHASE_START_UNIT
4		int	PURCHASE_START_OFFSET
4		timestamp	PURCHASE_END_T
4		int	PURCHASE_END_UNIT
4		int	PURCHASE_END_OFFSET
4		decimal	PURCHASE_DISCOUNT
4		decimal	PURCHASE_DISC_AMT
4		decimal	PURCHASE_FEE_AMT
4		timestamp	CYCLE_START_T
4		int	CYCLE_START_UNIT
4		int	CYCLE_START_OFFSET
4		timestamp	CYCLE_END_T
4		int	CYCLE_END_UNIT
4		int	CYCLE_END_OFFSET
4		decimal	CYCLE_DISCOUNT
4		decimal	CYCLE_DISC_AMT
4		decimal	CYCLE_FEE_AMT
4		timestamp	USAGE_START_T
4		int	USAGE_START_UNIT
4		int	USAGE_START_OFFSET
4		timestamp	USAGE_END_T
4		int	USAGE_END_UNIT
4		int	USAGE_END_OFFSET
4		decimal	USAGE_DISCOUNT
4		string	DESCR
4		string	PRICE_LIST_NAME
3		array	DISCOUNTS
4		poid	DISCOUNT_OBJ
4		poid	PLAN_OBJ
4		poid	OFFERING_OBJ
4		int	PACKAGE_ID
4		decimal	QUANTITY
4		enum	STATUS
4		int	STATUS_FLAGS
4		timestamp	PURCHASE_START_T
4		int	PURCHASE_START_UNIT
4		int	PURCHASE_START_OFFSET
4		timestamp	PURCHASE_END_T
4		int	PURCHASE_END_UNIT
4		int	PURCHASE_END_OFFSET
4		timestamp	CYCLE_START_T
4		int	CYCLE_START_UNIT
4		int	CYCLE_START_OFFSET
4		timestamp	CYCLE_END_T
4		int	CYCLE_END_UNIT
4		int	CYCLE_END_OFFSET
4		timestamp	USAGE_START_T
4		int	USAGE_START_UNIT
4		int	USAGE_START_OFFSET
4		timestamp	USAGE_END_T
4		int	USAGE_END_UNIT
4		int	USAGE_END_OFFSET
4		string	DESCR
3		array	PERMITTEDS
4		string	OBJ_TYPE
1		array	STATUSES
2		enum	STATUS
2		int	STATUS_FLAGS
2		timestamp	CLOSE_WHEN_T
1		array	PROFILES
2		poid	PROFILE_OBJ
2		substruct	INHERITED_INFO
1		substruct	INHERITED_INFO
1		array	DEVICES
2		poid	DEVICE_OBJ
0		array	BILLINFO
1		poid	POID
1		poid	BUSINESS_PROFILE_OBJ
1		string	BILLINFO_ID
1		int	ACTG_CYCLE_DOM
1		poid	PAYINFO_OBJ
1		poid	BAL_GRP_OBJ
1		int	FLAGS
1		enum	PAY_TYPE
1		int	PARENT_FLAGS
1		int	BILL_WHEN
1		int	ACTG_FUTURE_DOM
1		enum	ACTG_TYPE
1		enum	BILLING_STATUS
1		int	BILLING_STATUS_FLAGS
1		enum	STATUS
1		int	STATUS_FLAGS
1		int	SPONSOR_FLAGS
1		int	SPONSOREE_FLAGS
1		poid	AR_BILLINFO_OBJ
1		poid	PARENT_BILLINFO_OBJ
1		int	CURRENCY
1		int	CURRENCY_SECONDARY
1		enum	BILLING_SEGMENT
1		timestamp	EFFECTIVE_T
0		array	BAL_INFO
1		poid	POID
1		string	NAME
1		poid	BILLINFO_OBJ
1		poid	ACCOUNT_OBJ
1		poid	SERVICE_OBJ
1		array	LIMIT
2		decimal	CREDIT_LIMIT
2		decimal	CREDIT_FLOOR
2		int	CREDIT_THRESHOLDS
2		array	THRESHOLDS
3		int	THRESHOLD
1		array	RULES
2		enum	CONSUMPTION_RULE
0		array	PAYINFO
1		poid	POID
1		enum	PAY_TYPE
1		enum	PAYMENT_TERM
1		int	PAYMENT_OFFSET
1		enum	INV_TYPE
1		int	FLAGS
1		substruct	INHERITED_INFO
2		array	INV_INFO
3		string	ADDRESS
3		string	CITY
3		string	COUNTRY
3		string	DELIVERY_DESCR
3		enum	DELIVERY_PREFER
3		string	INV_INSTR
3		enum	INV_TERMS
3		string	EMAIL_ADDR
3		string	NAME
3		string	STATE
3		string	ZIP
2		array	CC_INFO
3		string	ADDRESS
3		string	CITY
3		string	COUNTRY
3		string	DEBIT_EXP
3		string	DEBIT_NUM
3		string	NAME
3		string	SECURITY_ID
3		string	STATE
3		string	ZIP
2		array	DD_INFO
3		string	ADDRESS
3		string	BANK_NO
3		string	CITY
3		string	COUNTRY
3		string	DEBIT_NUM
3		string	NAME
3		string	STATE
3		enum	TYPE
3		string	ZIP
2		array	SEPA_INFO
3		enum	MANDATE_TYPE
3		string	IBAN
3		string	BIC
3		string	MANDATE_CONTRACT_ID
3		string	MANDATE_CONTRACT_DESCR
3		string	MANDATE_UNIQUE_REFERENCE
3		array	DEBTOR_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	NAME
4		string	ZIP
4		string	IDENTIFICATION_CODE
4		string	REF_PARTY
4		string	REF_PARTY_ID_CODE
3		string	CREDITOR_ID
3		string	CREDITOR_NAME
0		array	PROFILES
1		poid	PROFILE_OBJ
1		substruct	INHERITED_INFO
0		array	TOPUP_INFO
1		poid	POID
1		poid	ACCOUNT_OBJ
1		array	PAYINFO
2		poid	POID
2		enum	PAY_TYPE
2		enum	PAYMENT_TERM
2		int	PAYMENT_OFFSET
2		string	NAME
2		enum	INV_TYPE
2		int	FLAGS
2		substruct	INHERITED_INFO
3		array	INV_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DELIVERY_DESCR
4		enum	DELIVERY_PREFER
4		string	INV_INSTR
4		enum	INV_TERMS
4		string	EMAIL_ADDR
4		string	NAME
4		string	STATE
4		string	ZIP
3		array	CC_INFO
4		string	ADDRESS
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_EXP
4		string	DEBIT_NUM
4		string	NAME
4		string	SECURITY_ID
4		string	STATE
4		string	ZIP
3		array	DD_INFO
4		string	ADDRESS
4		string	BANK_NO
4		string	CITY
4		string	COUNTRY
4		string	DEBIT_NUM
4		string	NAME
4		string	STATE
4		enum	TYPE
4		string	ZIP
3		array	SEPA_INFO
4		enum	MANDATE_TYPE
4		string	IBAN
4		string	BIC
4		string	MANDATE_CONTRACT_ID
4		string	MANDATE_CONTRACT_DESCR
4		string	MANDATE_UNIQUE_REFERENCE
4		timestamp	MANDATE_SIGNED_T
4		string	MANDATE_SIGNED_PLACE
4		array	DEBTOR_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	NAME
5		string	ZIP
5		string	IDENTIFICATION_CODE
5		string	REF_PARTY
5		string	REF_PARTY_ID_CODE
4		string	CREDITOR_ID
4		string	CREDITOR_NAME
1		array	BILLINFO
2		poid	POID
2		poid	BUSINESS_PROFILE_OBJ
2		string	BILLINFO_ID
2		array	PAYINFO
3		poid	POID
3		enum	PAY_TYPE
3		enum	PAYMENT_TERM
3		int	PAYMENT_OFFSET
3		string	NAME
3		enum	INV_TYPE
3		int	FLAGS
3		substruct	INHERITED_INFO
4		array	INV_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DELIVERY_DESCR
5		enum	DELIVERY_PREFER
5		string	INV_INSTR
5		enum	INV_TERMS
5		string	EMAIL_ADDR
5		string	NAME
5		string	STATE
5		string	ZIP
4		array	CC_INFO
5		string	ADDRESS
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_EXP
5		string	DEBIT_NUM
5		string	NAME
5		string	SECURITY_ID
5		string	STATE
5		string	ZIP
4		array	DD_INFO
5		string	ADDRESS
5		string	BANK_NO
5		string	CITY
5		string	COUNTRY
5		string	DEBIT_NUM
5		string	NAME
5		string	STATE
5		enum	TYPE
5		string	ZIP
4		array	SEPA_INFO
5		enum	MANDATE_TYPE
5		string	IBAN
5		string	BIC
5		string	MANDATE_CONTRACT_ID
5		string	MANDATE_CONTRACT_DESCR
5		string	MANDATE_UNIQUE_REFERENCE
5		timestamp	MANDATE_SIGNED_T
5		string	MANDATE_SIGNED_PLACE
5		array	DEBTOR_INFO
6		string	ADDRESS
6		string	CITY
6		string	COUNTRY
6		string	NAME
6		string	ZIP
6		string	IDENTIFICATION_CODE
6		string	REF_PARTY
6		string	REF_PARTY_ID_CODE
5		string	CREDITOR_ID
5		string	CREDITOR_NAME
2		array	BAL_INFO
3		poid	POID
3		string	NAME
3		array	BILLINFO
3		poid	BILLINFO_OBJ
3		array	LIMIT
4		decimal	CREDIT_LIMIT
4		decimal	CREDIT_FLOOR
4		decimal	CREDIT_THRESHOLDS_FIXED
4		int	CREDIT_THRESHOLDS
4		array	THRESHOLDS
5		int	THRESHOLD
5		decimal	AMOUNT
3		array	RULES
4		enum	CONSUMPTION_RULE
2		enum	PAY_TYPE
2		int	PARENT_FLAGS
2		int	BILL_WHEN
2		int	ACTG_FUTURE_DOM
2		enum	ACTG_TYPE
2		enum	BILLING_STATUS
2		int	BILLING_STATUS_FLAGS
2		enum	STATUS
2		int	STATUS_FLAGS
2		int	SPONSOR_FLAGS
2		int	SPONSOREE_FLAGS
2		poid	AR_BILLINFO_OBJ
2		poid	PARENT_BILLINFO_OBJ
2		int	CURRENCY
2		int	CURRENCY_SECONDARY
2		enum	BILLING_SEGMENT
1		poid	PAYINFO_OBJ
1		poid	BILLINFO_OBJ
1		decimal	TOPUP_AMT
1		decimal	TOPUP_CAP
1		decimal	CYCLE_TOPPED_AMT
1		timestamp	LAST_TOPUP_T
1		array	GROUP_TOPUP_INFO
2		poid	POID
2		poid	PARENT
2		string	NAME
2		poid	BAL_GRP_OBJ
2		array	GROUP_TOPUP_LIMITS
3		int	RESOURCE_ID
3		decimal	TOPUP_AMT
3		decimal	TOPUP_CAP
2		array	GROUP_TOPUP_MEMBERS
3		poid	BAL_GRP_OBJ
3		int	TOPUP_INTERVAL
3		string	PIN
3		enum	STATUS
0		substruct	CONTEXT_INFO
1		string	CORRELATION_ID
1		string	EXTERNAL_USER

---

Input details

0	poid    POID	In Out

	Use		required
	Class		/plan
	Class		/account

The poid of the chosen addon plan or account to be modified.

---

0	poid    ACCOUNT_OBJ	In Out

	Use		required
	Class		/account

The poid of account object to be modified.

---

0	timestamp    END_T	In Out

	Use		optional

This field represents the timestamp at which the event ends. This also represents the effective time of update to this account, on an external system. If this field is not specified, then current time on the Oracle Monetization Cloud server will be considered.

---

0	timestamp    START_T	In Out

	Use		optional

This would be the timestamp to be used to generate events. If not specified, the current time on the Oracle Monetization Cloud server will be considered.

---

0	string    PROGRAM_NAME	In Out

	Use		optional
	Max length		60

The name of the program that executed this operation.

---

0	array    ACCTINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0
	Allow ELEMID_ANY		false

Information to be stored in the account object will be passed in the acctinfo.

---

1	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO
	Class		/deal

Account level deal to purchase (if any).

---

1	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO
	Recursive		false

Deal to be purchased at account level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO
	Max length		255

Name of the deal object. Present only if a customized deal is to be purchased.

---

2	string    DESCR	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

2	timestamp    START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

2	timestamp    END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

2	array    PRODUCTS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

3	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

3	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

3	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

3	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

3	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

3	string    DESCR	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

3	string    PRICE_LIST_NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.PRODUCTS
	Max length		255

Price list name associated with this offering.

---

2	array    DISCOUNTS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

3	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For later use.

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

3	string    DESCR	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

2	array    PERMITTEDS	In Out

	Use		optional
	Parent		in.ACCTINFO.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

3	string    OBJ_TYPE	In Out

	Use		required
	Parent		in.ACCTINFO.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    BAL_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

Account level balance group indicator. Here the array does not contain anything but the element-id is significant. It indicates which balance group element in the input is account level. It is recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a default balance group will be created.

---

2	poid    POID	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO
	Max length		255

Balance Group name.

---

2	array    BILLINFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    POID	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

3	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

3	string    BILLINFO_ID	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

3	array    PAYINFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

4	poid    POID	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

4	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

4	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

4	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

---

4	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

4	int    FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

4	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

5	array    INV_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

6	string    CITY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

6	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

6	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

6	string    INV_INSTR	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

6	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

6	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

5	array    CC_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

6	string    CITY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

6	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

6	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

6	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

5	array    DD_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

6	string    BANK_NO	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

6	string    CITY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

6	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

6	enum    TYPE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

5	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

6	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

6	string    IBAN	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

6	string    BIC	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

6	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

6	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

6	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

6	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

7	string    ADDRESS	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

7	string    CITY	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

7	string    COUNTRY	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

7	string    NAME	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

7	string    ZIP	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

7	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

7	string    REF_PARTY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

7	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

6	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

6	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

3	array    BAL_INFO	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

3	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

3	int    BILL_WHEN	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

Anniversary billing slot.

---

3	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

3	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

3	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

3	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

3	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

3	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

3	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

3	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

3	int    CURRENCY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

2	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

2	array    LIMIT	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

3	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

3	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

3	array    THRESHOLDS	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

4	int    THRESHOLD	In Out

	Use		required
	Parent		in.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

4	decimal    AMOUNT	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

2	array    RULES	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

3	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		in.ACCTINFO.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		in.ACCTINFO
	Class		/balance_group

The balance group object for the account. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

---

1	int    CURRENCY	In Out

	Use		required
	Parent		in.ACCTINFO

The primary currency of the account. Also this acts as element-id of primary balance element for accounting roll-up. If not provided the default account currency information will be read from CM's pin.conf.

---

1	int    CURRENCY_SECONDARY	In Out

	Use		required
	Parent		in.ACCTINFO

The secondary currency of the account. Also this acts as element-id of secondary balance element for accounting roll-up.

---

0	array    SERVICES	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

This represents services array.

---

1	poid    SERVICE_OBJ	In Out

	Use		required
	Parent		in.SERVICES
	Mode		typeonly
	Class		/service

Partial poid of service object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored.

---

1	int    SUBSCRIPTION_INDEX	In Out

	Use		optional
	Parent		in.SERVICES

If this is a member service of a line/subscription, the index points to the parent/subscription service of the line. The member service object, when created, will refer the parent/subscription service using the SUBSCRIPTION_OBJ field. For all other services, the default is 0.

---

1	poid    SUBSCRIPTION_OBJ	In Out

	Use		optional
	Parent		in.SERVICES
	Class		/service

Subscription service object type only POID. This is an optional field, and it refers to the subscription service object of which this service is a member of.

---

1	string    SERVICE_ID	In Out

	Use		optional
	Parent		in.SERVICES
	Max length		255

User defined name for the service. This identifies the service uniquely within the plan.

---

1	array    BAL_INFO	In Out

	Use		optional
	Parent		in.SERVICES
	ElemID mode		key
	Min number of Elements		0
	Max number of Elements		1

Balance Group array which this service instance is associated to. The element-id is significant not the contents of the array. The element-id will be used to identify which balance group array to use from the input to associate the service to. if not specified the service will be associated with the account level balance group.

---

2	poid    POID	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO
	Max length		255

Balance Group name.

---

2	array    BILLINFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    POID	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

3	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

3	string    BILLINFO_ID	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

3	array    PAYINFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

4	poid    POID	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

4	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

4	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

4	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

---

4	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

4	int    FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

4	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

5	array    INV_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

6	string    CITY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

6	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

6	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

6	string    INV_INSTR	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

6	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

6	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

5	array    CC_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

6	string    CITY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

6	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

6	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

6	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

5	array    DD_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

6	string    BANK_NO	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

6	string    CITY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

6	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

6	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

6	string    STATE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

6	enum    TYPE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

6	string    ZIP	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

5	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

6	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

6	string    IBAN	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

6	string    BIC	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

6	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

6	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

6	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

6	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

7	string    ADDRESS	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

7	string    CITY	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

7	string    COUNTRY	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

7	string    NAME	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

7	string    ZIP	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

7	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

7	string    REF_PARTY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

7	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

6	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

6	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

3	array    BAL_INFO	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

3	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

3	int    BILL_WHEN	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

Anniversary billing slot.

---

3	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

3	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

3	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

3	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

3	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

3	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

3	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

3	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

3	int    CURRENCY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

2	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

2	array    LIMIT	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

3	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

3	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

3	array    THRESHOLDS	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

4	int    THRESHOLD	In Out

	Use		required
	Parent		in.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

4	decimal    AMOUNT	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

2	array    RULES	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

3	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		in.SERVICES.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		in.SERVICES
	Class		/balance_group

The balance group object for the service. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

---

1	string    LOGIN	In Out

	Use		optional
	Parent		in.SERVICES
	Max length		255

Login for service object. It is optional for telco and GSM services, mandatory for email and ip services.

---

1	array    ALIAS_LIST	In Out

	Use		optional
	Parent		in.SERVICES
	ElemID mode		index
	Min number of Elements		0

The array of new aliases. The element-id is significant.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.ALIAS_LIST
	Max length		128

The alias.

---

1	string    PASSWD_CLEAR	In Out

	Use		optional
	Parent		in.SERVICES
	Max length		255

Password for service object.

---

1	enum    PASSWD_STATUS	In Out

	Use		optional
	Parent		in.SERVICES

0	The password status is valid and normal (PIN_SERV_PASSWDSTATUS_NORMAL).
1	The password status is valid and is temporary (PIN_SERV_PASSWDSTATUS_TEMPORARY).
2	The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES).
3	The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID).

Desired password status. The possible values are NORMAL(0), TEMP(1), EXPIRES(2) and INVALID(3).

---

1	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		in.SERVICES
	Class		/deal

Deal that service object purchased (if any). This is for backward compatibility for the Plan not having PIN_FLD_DEALS array.

---

1	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		in.SERVICES
	Recursive		false

Deal to be purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO
	Max length		255

Name of the deal object. Present only if a customized deal is to be purchased.

---

2	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

2	timestamp    START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

2	timestamp    END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

2	array    PRODUCTS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

3	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

3	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

3	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

3	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

3	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

3	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

3	string    PRICE_LIST_NAME	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.PRODUCTS
	Max length		255

Price list name associated with this offering.

---

2	array    DISCOUNTS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

3	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For later use.

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

3	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

2	array    PERMITTEDS	In Out

	Use		optional
	Parent		in.SERVICES.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

3	string    OBJ_TYPE	In Out

	Use		required
	Parent		in.SERVICES.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    DEALS	In Out

	Use		optional
	Parent		in.SERVICES
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

This is the array of deals that this service purchases.

---

2	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.DEALS
	Class		/deal

This indicates the deal poid that will be purchased without customization.

---

2	enum    TYPE	In Out

	Use		optional
	Parent		in.SERVICES.DEALS

0	PIN_PRICE_DEAL_OPTIONAL
1	PIN_PRICE_DEAL_REQUIRED

Deal option type. Required only if a valid service id is provided.

---

2	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		in.SERVICES.DEALS
	Recursive		false

Deal to be purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO
	Max length		255

Name of the deal object. Present only if a customized deal is to be purchased.

---

3	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

3	timestamp    START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

3	timestamp    END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

3	int    FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

3	array    PRODUCTS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

4	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

4	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

4	decimal    QUANTITY	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

4	enum    STATUS	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

4	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

4	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

4	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

4	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

4	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

4	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

4	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object. The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.

---

4	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

4	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

4	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

4	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

4	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

4	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

4	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.The value of STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.

---

4	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Status flags used in conjunction with the override prices specified in PURCHASE_FEE_AMT and CYCLE_FEE_AMT. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

4	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

4	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

4	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

4	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

4	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

4	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

3	array    DISCOUNTS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

4	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

4	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

4	decimal    QUANTITY	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

4	enum    STATUS	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

4	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For later use.

---

4	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

4	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

4	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

4	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

4	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

4	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

4	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

4	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

4	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

4	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

4	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

4	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

4	string    DESCR	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

3	array    PERMITTEDS	In Out

	Use		optional
	Parent		in.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

4	string    OBJ_TYPE	In Out

	Use		required
	Parent		in.SERVICES.DEALS.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    STATUSES	In Out

	Use		optional
	Parent		in.SERVICES
	Min number of Elements		0
	Max number of Elements		1

Desired Status Info - if not specified, an active service is created. The element-id is not significant.

---

2	enum    STATUS	In Out

	Use		required
	Parent		in.SERVICES.STATUSES

10100	Indicates an active service(PIN_STATUS_ACTIVE).
10102	Indicates an inactive service(PIN_STATUS_INACTIVE).
10103	Indicates a closed service(PIN_STATUS_CLOSED).

Desired status of the service. The possible values of this field would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).

---

2	int    STATUS_FLAGS	In Out

	Use		required
	Parent		in.SERVICES.STATUSES

Desired status flags. This indicates a reason for this service to become inactive or closed.

---

2	timestamp    CLOSE_WHEN_T	In Out

	Use		optional
	Parent		in.SERVICES.STATUSES

Desired service close time

---

1	array    PROFILES	In Out

	Use		optional
	Parent		in.SERVICES
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Profiles associate with this service

---

2	poid    PROFILE_OBJ	In Out

	Use		required
	Parent		in.SERVICES.PROFILES
	Mode		typeonly
	Class		/profile

Partial poid of profile object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored. To modify a profile, specify the complete poid of the profile object.

---

2	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.SERVICES.PROFILES

Inherited info for profile object.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.SERVICES

Inherited info for service object.

---

1	array    DEVICES	In Out

	Use		optional
	Parent		in.SERVICES
	Min number of Elements		0

This is a devices array. This contains an array of device poids to be associated with the service being created.

---

2	poid    DEVICE_OBJ	In Out

	Use		required
	Parent		in.SERVICES.DEVICES
	Class		/device

Poid of the device that is to be associated.

---

0	array    BILLINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This represents the array of Billing info's. The element id is significant as it behaves as a key, in other objects like balance groups (bal_info array) to be created during this operation, to identify which billinfo element to associate with.

---

1	poid    POID	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/billinfo

The type only billinfo poid to create the billinfo. To update the existing billinfo, specify the complete billinfo poid. If poid is not passed all billinfo's for the account will be picked up for modification.

---

1	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

1	string    BILLINFO_ID	In Out

	Use		optional
	Parent		in.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

1	int    ACTG_CYCLE_DOM	In Out

	Use		optional
	Parent		in.BILLINFO

Billing date

---

1	array    PAYINFO	In Out

	Use		optional
	Parent		in.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

2	poid    POID	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

2	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

2	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO

Payment offset value.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO

---

2	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

2	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

3	array    INV_INFO	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

4	string    CITY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

4	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

4	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

4	string    INV_INSTR	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

4	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

4	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

3	array    CC_INFO	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

4	string    CITY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

4	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

4	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

4	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

3	array    DD_INFO	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

4	string    BANK_NO	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

4	string    CITY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

4	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

4	enum    TYPE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

3	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

4	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

4	string    IBAN	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

4	string    BIC	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

4	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

4	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

4	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

4	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

5	string    ADDRESS	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

5	string    CITY	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

5	string    COUNTRY	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

5	string    NAME	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

5	string    ZIP	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

5	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

5	string    REF_PARTY	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

5	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

4	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

4	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

1	array    BAL_INFO	In Out

	Use		optional
	Parent		in.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

2	poid    POID	In Out

	Use		required
	Parent		in.BILLINFO.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO
	Max length		255

Balance Group name.

---

2	array    BILLINFO	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

2	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

2	array    LIMIT	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

3	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

3	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

3	array    THRESHOLDS	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

4	int    THRESHOLD	In Out

	Use		required
	Parent		in.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

4	decimal    AMOUNT	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

2	array    RULES	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

3	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		in.BILLINFO.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

1	poid    PAYINFO_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/payinfo

The payinfo poid that this billinfo is associated with. If PIN_FLD_PAYINFO is specified, this field will be ignored.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/balance_group

The balance group that this billinfo is associated with. If PIN_FLD_BAL_INFO is specified, this field will be ignored.

---

1	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.BILLINFO

0	Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).

This represents the type of billing for user.

---

1	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO

Indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

1	int    BILL_WHEN	In Out

	Use		optional
	Parent		in.BILLINFO

Anniversary billing slot.

---

1	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		in.BILLINFO

New Accounting Close day-of-month (1-31).

---

1	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		in.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

1	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		in.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

1	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO

Indicates a reason for setting of the given billing status.

---

1	enum    STATUS	In Out

	Use		optional
	Parent		in.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

1	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO

Indicates a reason for setting of the given status.

---

1	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

1	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		in.BILLINFO

It indicates whether this billinfo has a sponsor.

---

1	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

1	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

1	int    CURRENCY	In Out

	Use		optional
	Parent		in.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

1	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		in.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

1	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		in.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

0	array    BAL_INFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

The Balance Group array. List of balance groups that need to be created or updated.

---

1	poid    POID	In Out

	Use		required
	Parent		in.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used. To modify an existing balance group, specify the full POID.

---

1	string    NAME	In Out

	Use		optional
	Parent		in.BAL_INFO
	Max length		255

Balance Group name

---

1	array    BILLINFO	In Out

	Use		optional
	Parent		in.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

2	poid    POID	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

2	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

2	string    BILLINFO_ID	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

2	array    PAYINFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

3	poid    POID	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

3	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

3	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

---

3	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

3	int    FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

3	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

4	array    INV_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

5	string    CITY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

5	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

5	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

5	string    INV_INSTR	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

5	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

5	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

4	array    CC_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

5	string    CITY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

5	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

5	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

5	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

4	array    DD_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

5	string    BANK_NO	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

5	string    CITY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

5	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

5	enum    TYPE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

4	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

5	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

5	string    IBAN	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

5	string    BIC	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

5	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

5	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

5	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

5	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

6	string    ADDRESS	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

6	string    CITY	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

6	string    COUNTRY	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

6	string    NAME	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

6	string    ZIP	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

6	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

6	string    REF_PARTY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

6	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

5	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

5	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

2	array    BAL_INFO	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.BAL_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

2	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

2	int    BILL_WHEN	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

Anniversary billing slot.

---

2	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

2	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

2	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

2	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

2	enum    STATUS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

2	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

2	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

2	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

2	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

2	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

2	int    CURRENCY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		in.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

1	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

1	array    LIMIT	In Out

	Use		optional
	Parent		in.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

2	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		in.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

2	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		in.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

2	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		in.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

2	array    THRESHOLDS	In Out

	Use		optional
	Parent		in.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

3	int    THRESHOLD	In Out

	Use		required
	Parent		in.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

3	decimal    AMOUNT	In Out

	Use		optional
	Parent		in.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

1	array    RULES	In Out

	Use		optional
	Parent		in.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

2	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		in.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

0	array    PAYINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		1

This is an array of payment methods to be associated with this account.

---

1	poid    POID	In Out

	Use		required
	Parent		in.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo to be created. In case of an update to an existing payinfo, specifiy the actual payinfo poid.

---

1	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.PAYINFO

0	Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).

This represents the type of billing for user.

---

1	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

1	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.PAYINFO

Payment Offset.

---

1	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT)
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

1	int    FLAGS	In Out

	Use		optional
	Parent		in.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

2	array    INV_INFO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

3	string    CITY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

3	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

3	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

3	string    INV_INSTR	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

3	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

3	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

3	string    STATE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

3	string    ZIP	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

2	array    CC_INFO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address.

---

3	string    CITY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

3	string    DEBIT_EXP	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

3	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

3	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

3	string    STATE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

3	string    ZIP	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

2	array    DD_INFO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

3	string    BANK_NO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

3	string    CITY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

3	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

3	string    STATE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

3	enum    TYPE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type- Checking(1), savings(2) or corporate(3).

---

3	string    ZIP	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

2	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment menthod. There will be only one element and element id is not significant.

---

3	enum    MANDATE_TYPE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

3	string    IBAN	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

3	string    BIC	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

3	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

3	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

3	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

3	array    DEBTOR_INFO	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

4	string    CITY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

4	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

4	string    REF_PARTY	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

4	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

3	string    CREDITOR_ID	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

3	string    CREDITOR_NAME	In Out

	Use		optional
	Parent		in.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

0	array    PROFILES	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

This represnts Profile array to be associated with the account.

---

1	poid    PROFILE_OBJ	In Out

	Use		required
	Parent		in.PROFILES
	Mode		typeonly
	Class		/profile

Partial poid of profile object to create. The 'type' and 'database' sub-fields are used in the creation. The other sub-fields are ignored. In case of modification to an existing profile specify the actual poid of the profile.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.PROFILES
	Recursive		false

Inherited info for profile object.

---

0	array    TOPUP_INFO	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Topup array

---

1	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO
	Class		/topup

Topup poid - type only for creation.

---

1	poid    ACCOUNT_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO
	Class		/account

Account poid.

---

1	array    PAYINFO	In Out

	Use		required
	Parent		in.TOPUP_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		1

The element-id is significant. Contents are not significant. The element id points to the payinfo array element in the request to be used for top-up.

---

2	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

2	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

2	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO

Payment offset value.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO

---

2	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

2	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

3	array    INV_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

4	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

4	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

4	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

4	string    INV_INSTR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

4	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

4	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

3	array    CC_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

4	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

4	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

4	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

4	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

3	array    DD_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

4	string    BANK_NO	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

4	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

4	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

4	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

4	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

4	enum    TYPE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

4	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

3	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

4	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

4	string    IBAN	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

4	string    BIC	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

4	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

4	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

4	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

4	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

5	string    ADDRESS	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

5	string    CITY	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

5	string    COUNTRY	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

5	string    NAME	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

5	string    ZIP	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

5	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

5	string    REF_PARTY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

5	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

4	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

4	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

1	poid    PAYINFO_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO
	Class		/payinfo

The payinfo object that this topup is associated with. If PIN_FLD_PAYINFO is passed in, this field will be ignored. If PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.

---

1	array    BILLINFO	In Out

	Use		required
	Parent		in.TOPUP_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		1

The element-id is significant. Contents are not significant. The element id points to the billinfo array element in the request to be used for top-up.

---

2	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

2	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

2	string    BILLINFO_ID	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

2	array    PAYINFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

3	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

3	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

3	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

Payment offset value.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

---

3	enum    INV_TYPE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

3	int    FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

3	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

4	array    INV_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

5	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

5	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

5	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

5	string    INV_INSTR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

5	enum    INV_TERMS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

5	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

4	array    CC_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

5	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

5	string    DEBIT_EXP	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

5	string    DEBIT_NUM	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

5	string    SECURITY_ID	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

4	array    DD_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

5	string    BANK_NO	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

5	string    CITY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

5	string    DEBIT_NUM	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

5	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

5	string    STATE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

5	enum    TYPE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

5	string    ZIP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

4	array    SEPA_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

5	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

5	string    IBAN	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

5	string    BIC	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

5	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

5	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

5	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

5	array    DEBTOR_INFO	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

6	string    ADDRESS	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

6	string    CITY	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

6	string    COUNTRY	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

6	string    NAME	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

6	string    ZIP	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

6	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

6	string    REF_PARTY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

6	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

5	string    CREDITOR_ID	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

5	string    CREDITOR_NAME	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

2	array    BAL_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

3	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	Max length		255

Balance Group name.

---

3	array    BILLINFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

3	array    LIMIT	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

4	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

4	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

4	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

4	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

4	array    THRESHOLDS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

5	int    THRESHOLD	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

5	decimal    AMOUNT	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

3	array    RULES	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

4	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		in.TOPUP_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

2	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

2	int    BILL_WHEN	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

Anniversary billing slot.

---

2	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

2	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

2	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

2	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

2	enum    STATUS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

2	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

2	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

2	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

2	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

2	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

2	int    CURRENCY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		in.TOPUP_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

1	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO
	Class		/billinfo

The POID of Billinfo that this topup is associated with. If PIN_FLD_BILLINFO is passed in, this field will be ignored. If PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.

---

1	decimal    TOPUP_AMT	In Out

	Use		required
	Parent		in.TOPUP_INFO

This represents Topup amount. In case of auto-topups this will indicate the amount to topup with.

---

1	decimal    TOPUP_CAP	In Out

	Use		optional
	Parent		in.TOPUP_INFO

Topup cap indicates the max topup that can be done for a given cycle. The cycle is driven by the cycle information set-up in the billinfo. A values of 0 means no cap.

---

1	decimal    CYCLE_TOPPED_AMT	In Out

	Use		optional
	Parent		in.TOPUP_INFO

This indicates the total topped up amount during the given cycle. This amount will be populated only if the cap is set.

---

1	timestamp    LAST_TOPUP_T	In Out

	Use		optional
	Parent		in.TOPUP_INFO

This indicates the when the last topup happened.

---

1	array    GROUP_TOPUP_INFO	In Out

	Use		optional
	Parent		in.TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

The field represents sponsored topup. The array contains fields related to Sponsored topup only.

---

2	poid    POID	In Out

	Use		required
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/group/topup

The /group/topup poid. Poid of sponsored topup group involved in the creation/modification of member account. If the object instance exists, the poid is complete poid with valid poid number. If no object instance exists, the poid is type only poid.

---

2	poid    PARENT	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/account

Parent's account poid.

---

2	string    NAME	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	Max length		255

The Name of the /group/topup. This helps to identify the group.

---

2	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/balance_group

Balance Group of the parent/payer of the /group/topup.

---

2	array    GROUP_TOPUP_LIMITS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Represents /group/topup financial properties per resource id.

---

3	int    RESOURCE_ID	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Resource id of topup operation

---

3	decimal    TOPUP_AMT	In Out

	Use		required
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup amount is used in automatic sponsored topup.

---

3	decimal    TOPUP_CAP	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup cap is used as a maximum limit of topup for particular topup group during cycle.

---

2	array    GROUP_TOPUP_MEMBERS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Represents members' properties of the /group/topup.

---

3	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
	Class		/balance_group

Balance Group of a member of the /group/topup.

---

3	int    TOPUP_INTERVAL	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

This indicates the interval at which automatic sponsored topup occur.

---

3	string    PIN	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
	Max length		60

The PIN which will be used for authentication during Ad-Hoc topup.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		in.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

10100	Indicates an active member(PIN_STATUS_ACTIVE).
10102	Indicates an inactive member(PIN_STATUS_INACTIVE).
10103	Indicates a closed member(PIN_STATUS_CLOSED).

The status of the member (active/inactive/closed).

---

0	substruct    CONTEXT_INFO	In Out

	Use		optional

Substruct to pass information from external clients.

---

1	string    CORRELATION_ID	In Out

	Use		optional
	Parent		in.CONTEXT_INFO
	Max length		128

Correlation id passed by an external system to Oracle Monetization Cloud.

---

1	string    EXTERNAL_USER	In Out

	Use		optional
	Parent		in.CONTEXT_INFO
	Max length		128

User of an external system connecting to Oracle Monetization Cloud.

---

---

Output details

0	poid    POID	In Out

	Use		required
	Class		/plan
	Class		/account

Poid of the plan or account passed in.

---

0	poid    ACCOUNT_OBJ	In Out

	Use		optional
	Class		/account

Poid of the modified account object.

---

0	timestamp    END_T	In Out

	Use		optional

This field represents the timestamp at which the event ends. Effective time of the update to this account, on an external system. If not specified, the current time on the Oracle Monetization Cloud server will be used.

---

0	timestamp    START_T	In Out

	Use		optional

This would be the timestamp to be used to generate events. If not specified, the current time on the Oracle Monetization Cloud server will be used.

---

0	string    PROGRAM_NAME	In Out

	Use		optional
	Max length		60

The name of the program that executed this operation.

---

0	array    ACCTINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		1
	Allow ELEMID_ANY		false

Information to be stored in the account object that was passed in.

---

1	poid    POID	In Out

	Use		required
	Parent		out.ACCTINFO
	Class		/account

Account poid.

---

1	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO
	Class		/deal

Account level deal purchased (if any).

---

1	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO
	Recursive		false

Deal purchased at account level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO
	Max length		255

Name of the object. Present only if a customized deal is to be purchased.

---

2	string    DESCR	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

2	timestamp    START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

2	timestamp    END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

2	array    PRODUCTS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

3	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

3	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS
	Class		/purchased_product

Poid of purchased product.

---

3	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

3	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

3	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

3	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

3	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

3	string    DESCR	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

3	string    PRICE_LIST_NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.PRODUCTS
	Max length		255

Price list name associated with this offering.

---

2	array    DISCOUNTS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

3	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

3	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS
	Class		/purchased_discount

Poid of purchased discount.

---

3	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For later use.

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

3	string    DESCR	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

2	array    PERMITTEDS	In Out

	Use		optional
	Parent		out.ACCTINFO.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

3	string    OBJ_TYPE	In Out

	Use		required
	Parent		out.ACCTINFO.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    BAL_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

Account level balance group indicator. Here the array does not contain anything but the element-id is significant. It indicates which balance group element in the input is account level. It is recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a default balance group will be created.

---

2	poid    POID	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO
	Max length		255

Balance Group name.

---

2	array    BILLINFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    POID	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

3	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

3	string    BILLINFO_ID	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

3	array    PAYINFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

4	poid    POID	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

4	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

4	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

4	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

---

4	enum    INV_TYPE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

4	int    FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

4	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

5	array    INV_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

6	string    CITY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

6	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

6	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

6	string    INV_INSTR	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

6	enum    INV_TERMS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

6	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

5	array    CC_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

6	string    CITY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

6	string    DEBIT_EXP	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

6	string    DEBIT_NUM	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

6	string    SECURITY_ID	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

5	array    DD_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

6	string    BANK_NO	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

6	string    CITY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

6	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

6	enum    TYPE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

5	array    SEPA_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

6	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

6	string    IBAN	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

6	string    BIC	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

6	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

6	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

6	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

6	array    DEBTOR_INFO	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

7	string    ADDRESS	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

7	string    CITY	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

7	string    COUNTRY	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

7	string    NAME	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

7	string    ZIP	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

7	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

7	string    REF_PARTY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

7	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

6	string    CREDITOR_ID	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

6	string    CREDITOR_NAME	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

3	array    BAL_INFO	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

3	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

3	int    BILL_WHEN	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

Anniversary billing slot.

---

3	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

3	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

3	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

3	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

3	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

3	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

3	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

3	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

3	int    CURRENCY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

2	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

2	array    LIMIT	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

3	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

3	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

3	array    THRESHOLDS	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

4	int    THRESHOLD	In Out

	Use		required
	Parent		out.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

4	decimal    AMOUNT	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

2	array    RULES	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

3	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		out.ACCTINFO.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		out.ACCTINFO
	Class		/balance_group

The balance group object for the account. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified.

---

1	int    CURRENCY	In Out

	Use		required
	Parent		out.ACCTINFO

This is the primary currency of the account. This acts as element-id of primary balance element for accounting roll-up. If not provided the default account currency information will be read from CM's pin.conf.

---

1	int    CURRENCY_SECONDARY	In Out

	Use		required
	Parent		out.ACCTINFO

The secondary currency of the account. Also this acts as element-id of secondary balance element for accounting roll-up.

---

0	array    SERVICES	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

This represents services array.

---

1	poid    SERVICE_OBJ	In Out

	Use		required
	Parent		out.SERVICES
	Class		/service

The poid of service object created.

---

1	int    SUBSCRIPTION_INDEX	In Out

	Use		optional
	Parent		out.SERVICES

If this is a member service of a line/subscription, the index points to the parent/subscription service of the line. The member service object, when created, will refer the parent/subscription service using the SUBSCRIPTION_OBJ field. For all other services, the default is 0.

---

1	poid    SUBSCRIPTION_OBJ	In Out

	Use		optional
	Parent		out.SERVICES
	Class		/service

Subscription service object POID. This is an optional field, and it refers to the subscription service object of which this service is a member of.

---

1	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.SERVICES
	Class		/billinfo

The billinfo object that this service belongs to.

---

1	string    SERVICE_ID	In Out

	Use		optional
	Parent		out.SERVICES
	Max length		255

User defined name for the service. This identifies the service uniquely within the plan.

---

1	array    BAL_INFO	In Out

	Use		optional
	Parent		out.SERVICES
	ElemID mode		key
	Min number of Elements		0
	Max number of Elements		1

Balance Group array which this service instance is associated to. The element-id is significant not the contents of the array. The element-id will be used to identify which balance group array to use from the input to associate the service to. if not specified the service will be associated with the account level balance group.

---

2	poid    POID	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO
	Max length		255

Balance Group name.

---

2	array    BILLINFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    POID	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

3	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

3	string    BILLINFO_ID	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

3	array    PAYINFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

4	poid    POID	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

4	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

4	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

4	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Payment offset value.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

---

4	enum    INV_TYPE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

4	int    FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

4	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

5	array    INV_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

6	string    CITY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

6	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

6	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

6	string    INV_INSTR	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

6	enum    INV_TERMS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

6	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

5	array    CC_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

6	string    CITY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

6	string    DEBIT_EXP	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

6	string    DEBIT_NUM	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

6	string    SECURITY_ID	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

5	array    DD_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

6	string    ADDRESS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

6	string    BANK_NO	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

6	string    CITY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

6	string    COUNTRY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

6	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

6	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

6	string    STATE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

6	enum    TYPE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

6	string    ZIP	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

5	array    SEPA_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

6	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

6	string    IBAN	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

6	string    BIC	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

6	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

6	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

6	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

6	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

6	array    DEBTOR_INFO	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

7	string    ADDRESS	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

7	string    CITY	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

7	string    COUNTRY	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

7	string    NAME	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

7	string    ZIP	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

7	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

7	string    REF_PARTY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

7	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

6	string    CREDITOR_ID	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

6	string    CREDITOR_NAME	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

3	array    BAL_INFO	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

3	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

3	int    BILL_WHEN	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

Anniversary billing slot.

---

3	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

3	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

3	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

3	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

3	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

3	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

3	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

3	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

3	int    CURRENCY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

3	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

2	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

2	array    LIMIT	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

3	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

3	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

3	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

3	array    THRESHOLDS	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

4	int    THRESHOLD	In Out

	Use		required
	Parent		out.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

4	decimal    AMOUNT	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

2	array    RULES	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

3	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		out.SERVICES.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		out.SERVICES
	Class		/balance_group

The balance group object for the service. Either PIN_FLD_BAL_INFO or PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed in, this field will be ignored.

---

1	string    LOGIN	In Out

	Use		optional
	Parent		out.SERVICES
	Max length		255

Login for service object.

---

1	array    ALIAS_LIST	In Out

	Use		optional
	Parent		out.SERVICES
	ElemID mode		index
	Min number of Elements		0

The array of new aliases.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.ALIAS_LIST
	Max length		128

The alias.

---

1	enum    PASSWD_STATUS	In Out

	Use		optional
	Parent		out.SERVICES

0	The password status is valid and normal (PIN_SERV_PASSWDSTATUS_NORMAL).
1	The password status is valid and is temporary (PIN_SERV_PASSWDSTATUS_TEMPORARY).
2	The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES).
3	The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID).

Desired password status. The possible values are NORMAL(0), TEMP(1), EXPIRES(2), INVALID(3).

---

1	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		out.SERVICES
	Class		/deal

Deal that service object purchased (if any). This is for backward compatibility for the Plan not having PIN_FLD_DEALS array.

---

1	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		out.SERVICES
	Recursive		false

Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO
	Max length		255

Name of the object. Present only if a customized deal is to be purchased.

---

2	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

2	timestamp    START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

2	timestamp    END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

2	array    PRODUCTS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

3	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

3	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS
	Class		/purchased_product

Poid of purchased product.

---

3	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

3	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

3	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

3	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

3	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

3	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

3	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

3	string    PRICE_LIST_NAME	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.PRODUCTS
	Max length		255

Price list name associated with this offering.

---

2	array    DISCOUNTS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

3	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

3	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

3	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS
	Class		/purchased_discount

Poid of purchased discount.

---

3	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

3	decimal    QUANTITY	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

3	enum    STATUS	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

3	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For later use.

---

3	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

3	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

3	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

3	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

3	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

3	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

3	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

3	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

3	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

3	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

3	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

3	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

3	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

3	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

2	array    PERMITTEDS	In Out

	Use		optional
	Parent		out.SERVICES.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

3	string    OBJ_TYPE	In Out

	Use		required
	Parent		out.SERVICES.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    DEALS	In Out

	Use		optional
	Parent		out.SERVICES
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

This is the array of deals that this service purchases.

---

2	poid    DEAL_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEALS
	Class		/deal

It indicates the deal poid that will be purchased without customization.

---

2	enum    TYPE	In Out

	Use		optional
	Parent		out.SERVICES.DEALS

0	PIN_PRICE_DEAL_OPTIONAL
1	PIN_PRICE_DEAL_REQUIRED

Deal option type. Required only if a valid service id is provided.

---

2	substruct    DEAL_INFO	In Out

	Use		optional
	Parent		out.SERVICES.DEALS
	Recursive		false

Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase the deal customized. So, the DEAL_INFO has the entire deal object (the products and discounts in the deal should be passed) in the PIN_FLD_DEAL_INFO sub-structure.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO
	Max length		255

Name of the object. Present only if a customized deal is to be purchased.

---

3	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO
	Max length		255

Deal description. This is a free text to describe product. Present only if a customized deal is to be purchased.

---

3	timestamp    START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO

Valid start time. Defines valid period for the deal object (inclusive). Stored as desired time in server timezone. Present only if a customized deal is to be purchased.

---

3	timestamp    END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO

Valid end time. Defines valid period for the deal object (non-inclusive). Stored as desired time in server timezone. If end time is zero, valid period does not expire. Present only if a customized deal is to be purchased.

---

3	int    FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

3	array    PRODUCTS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Products Array. Array of products to purchase for the deal. Present only if a customized deal is to be purchased.

---

4	poid    PRODUCT_OBJ	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Class		/product

Poid of the product to purchase.

---

4	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Class		/plan

Poid of plan through which product is being purchased.

---

4	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Class		/purchased_product

Poid of purchased product.

---

4	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

4	decimal    QUANTITY	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Quantity to purchase.

---

4	enum    STATUS	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription product. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

4	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Inital status flags. The possible values are: - PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000) PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)

---

4	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase start time. Number of seconds into the future relative to purchase time that product activates (0 means immediately).

---

4	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units, if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

4	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase end time. Number of seconds into the future relative to purchase time that product expires (0 means that product does not expire).

---

4	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

4	decimal    PURCHASE_DISCOUNT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase discount. The percentage discount applied to purchase/cancel rates of product.

---

4	decimal    PURCHASE_DISC_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount for purchase fees amount of discount applied to purchase/cancel rates of product.

---

4	decimal    PURCHASE_FEE_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Purchase fee to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

4	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this product (0 means immediately).

---

4	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, the start_offset will be 0 and relative offset can be specified for cycle if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

4	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this product (0 means always applied).

---

4	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative Unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for Cycle to be used in conjunction with unit to calculate cycle end_t.

---

4	decimal    CYCLE_DISCOUNT	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee discount. The percent discount applied to cycle rates of product.

---

4	decimal    CYCLE_DISC_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Fixed amount discount applied to cycle rates of product.

---

4	decimal    CYCLE_FEE_AMT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Cycle fee (both forward and arrears) to be applied for this product. Amount specified here will override the price specified in the /rate object.

---

4	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this product (0 means immediately).

---

4	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

4	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee end time. Number ofseconds into the future relative to purchase time that usage fees are no longer applied for this product (0 means always applied).

---

4	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Relative offset for usage to be used in conjunction with unit to calculate usage end_t.

---

4	decimal    USAGE_DISCOUNT	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS

Usage fee discount. The percent discount applied to usage rates of product.

---

4	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Max length		255

Description on a per product basis for CSR to add comments.

---

4	string    PRICE_LIST_NAME	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.PRODUCTS
	Max length		255

Price list name associated with this offering.

---

3	array    DISCOUNTS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored
	Iteration		undefined

Discounts Array. Array of discounts to purchase for the deal. Element-id is not significant. Present only if a customized deal is to be purchased.

---

4	poid    DISCOUNT_OBJ	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Class		/discount

Poid of discount to purchase.

---

4	poid    PLAN_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Class		/plan

Poid of plan through which discount is being purchased.

---

4	poid    OFFERING_OBJ	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Class		/purchased_discount

Poid of purchased discount.

---

4	int    PACKAGE_ID	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

This field is common for all product/discount instances purchased as part of deal or plan purchase. In case of deal purchase, all products/discounts within the deal will have the same package id. In case of plan purchase, all the products/discounts within the plan, will share the same package id.

---

4	decimal    QUANTITY	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Quantity to purchase.

---

4	enum    STATUS	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

0	NOT_SET
1	ACTIVE
2	INACTIVE
3	CANCELLED

Status of this subscription discount. Possible values are NOT_SET(0) ACTIVE(1) INACTIVE(2) CANCELLED(3)

---

4	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For later use.

---

4	timestamp    PURCHASE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase start time. Number of seconds into the future relative to purchase time that discount activates.

---

4	int    PURCHASE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate purchase_start_t with reference to the event time.

---

4	timestamp    PURCHASE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Purchase end time. Number of seconds into the future relative to purchase time that discount expires (0 means that discount does not expire).

---

4	int    PURCHASE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative Unit for Purchase can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    PURCHASE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Purchase to be used in conjunction with unit to calculate purchase end_t.

---

4	timestamp    CYCLE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee start time. Number of seconds into the future relative to purchase time that cycle fees begin for this discount (0 means immediately).

---

4	int    CYCLE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_unit will be -1. The start date can be specified in relative units if it is not set for first usage. The values can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, the start_offset will be 0 and relative offset can be specified for purchase, if first usage option is not marked. To be used in conjunction with unit to calculate cycle_start_t with reference to the event time.

---

4	timestamp    CYCLE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Cycle fee end time. Number of seconds into the future relative to purchase time that cycle fees are no longer applied for this discount (0 means always applied).

---

4	int    CYCLE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Cycle can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    CYCLE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Cycle to be used in conjunction with unit to calculate Cycle end_t.

---

4	timestamp    USAGE_START_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee start time. Number of seconds into the future relative to purchase time that usage fees begin for this discount (0 means immediately).

---

4	int    USAGE_START_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage start, this field is -1. Otherwise the start date is a relative offset, with the unit specified in this field as: Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_START_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

For first usage, this field is 0. Otherwise, the start date is a relative offset, which is specified by a combination of this field and the start unit field.

---

4	timestamp    USAGE_END_T	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Usage fee end time. Number of seconds into the future relative to purchase time that usage fees are no longer applied for this discount (0 means always applied).

---

4	int    USAGE_END_UNIT	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative unit for Usage can be Seconds(1) Minutes(2) Hours(3) Days(4) Months(5) Act Cycles(8)

---

4	int    USAGE_END_OFFSET	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS

Relative offset for Usage to be used in conjunction with unit to calculate Usage end_t on First Usage.

---

4	string    DESCR	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO.DISCOUNTS
	Max length		255

Description on a per discount basis for CSR to add comments.

---

3	array    PERMITTEDS	In Out

	Use		optional
	Parent		out.SERVICES.DEALS.DEAL_INFO
	ElemID mode		ignored

Permitted array. Contains type strings for account and service object types that are permitted to purchase this deal. Each entry is implicitly appended with a wildcard for checking, so account and service types that were inherited from a permitted type are also permitted themselves. No entries implies any account or service type is permitted to purchase the deal. Element-id is not significant.

---

4	string    OBJ_TYPE	In Out

	Use		required
	Parent		out.SERVICES.DEALS.DEAL_INFO.PERMITTEDS

Object type - identifies an allowed account or service object type.

---

1	array    STATUSES	In Out

	Use		optional
	Parent		out.SERVICES
	Min number of Elements		0
	Max number of Elements		1

Desired Status Info - if not specified, an active service is created. The element-id is not significant.

---

2	enum    STATUS	In Out

	Use		required
	Parent		out.SERVICES.STATUSES

10100	Indicates an active service(PIN_STATUS_ACTIVE).
10102	Indicates an inactive service(PIN_STATUS_INACTIVE).
10103	Indicates a closed service(PIN_STATUS_CLOSED).

Desired status of the service. The possible values of this field would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).

---

2	int    STATUS_FLAGS	In Out

	Use		required
	Parent		out.SERVICES.STATUSES

Desired status flags. This indicates a reason for this service to become inactive or closed.

---

2	timestamp    CLOSE_WHEN_T	In Out

	Use		optional
	Parent		out.SERVICES.STATUSES

Desired service close time.

---

1	array    PROFILES	In Out

	Use		optional
	Parent		out.SERVICES
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Profiles associate with this service.

---

2	poid    PROFILE_OBJ	In Out

	Use		required
	Parent		out.SERVICES.PROFILES
	Class		/profile

The poid of the profile object created.

---

2	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.SERVICES.PROFILES

Inherited info for profile object.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.SERVICES

Inherited info for service object.

---

1	array    DEVICES	In Out

	Use		optional
	Parent		out.SERVICES
	Min number of Elements		0

Devices array. This contains an array of device poids to be associated with the service being created.

---

2	poid    DEVICE_OBJ	In Out

	Use		required
	Parent		out.SERVICES.DEVICES
	Class		/device

Poid of the device that is associated.

---

0	array    BILLINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This represents the array of Billing info's specified.

---

1	poid    POID	In Out

	Use		required
	Parent		out.BILLINFO
	Class		/billinfo

The POID of billinfo

---

1	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		out.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

1	string    BILLINFO_ID	In Out

	Use		optional
	Parent		out.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

1	int    ACTG_CYCLE_DOM	In Out

	Use		optional
	Parent		out.BILLINFO

Billing date

---

1	poid    PAYINFO_OBJ	In Out

	Use		optional
	Parent		out.BILLINFO
	Class		/payinfo

The payinfo object that this billinfo is associated with.

---

1	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		out.BILLINFO
	Class		/balance_group

The balance group object that this billinfo is associated with.

---

1	int    FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

Flag to indicate on demand bill at the deal level and has value PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if a customized deal is to be purchased.

---

1	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.BILLINFO

0	Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).

This represents the type of billing for user.

---

1	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

Indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates. A value of 1 indicates that it has subordinates.

---

1	int    BILL_WHEN	In Out

	Use		optional
	Parent		out.BILLINFO

Anniversary billing slot.

---

1	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		out.BILLINFO

New Accounting Close day-of-month (1-31).

---

1	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		out.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

1	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		out.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

1	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

Indicates a reason for setting of the given billing status.

---

1	enum    STATUS	In Out

	Use		optional
	Parent		out.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

1	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

It indicates a reason for setting of the given status.

---

1	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

1	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		out.BILLINFO

It indicates whether this billinfo has a sponsor.

---

1	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

1	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

1	int    CURRENCY	In Out

	Use		optional
	Parent		out.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

1	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		out.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

1	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		out.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

1	timestamp    EFFECTIVE_T	In Out

	Use		optional
	Parent		out.BILLINFO

This field represents the timestamp of effective time of the update to this billinfo. If not specified, the current time on the Oracle Monetization Cloud server will be used.

---

0	array    BAL_INFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

The Balance Group array. List of balance groups that was to be created or updated in this operation.

---

1	poid    POID	In Out

	Use		required
	Parent		out.BAL_INFO
	Class		/balance_group

The balance group POID.

---

1	string    NAME	In Out

	Use		optional
	Parent		out.BAL_INFO
	Max length		255

Balance Group name.

---

1	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group is associated with.

---

1	poid    ACCOUNT_OBJ	In Out

	Use		optional
	Parent		out.BAL_INFO
	Class		/account

The account object that this bal-info is associated with.

---

1	poid    SERVICE_OBJ	In Out

	Use		optional
	Parent		out.BAL_INFO
	Class		/service

The service object that this bal-info is associated with.

---

1	array    LIMIT	In Out

	Use		optional
	Parent		out.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

2	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		out.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

2	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		out.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

2	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		out.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

2	array    THRESHOLDS	In Out

	Use		optional
	Parent		out.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

3	int    THRESHOLD	In Out

	Use		required
	Parent		out.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

1	array    RULES	In Out

	Use		optional
	Parent		out.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

2	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		out.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

0	array    PAYINFO	In Out

	Use		optional
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		1

Array of payment methods associated with this account.

---

1	poid    POID	In Out

	Use		required
	Parent		out.PAYINFO
	Class		/payinfo

The POID of the payinfo object created or updated.

---

1	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.PAYINFO

0	Undefined pay type(PIN_PAY_TYPE_UNDEFINED).
10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).

This represents the type of billing for user.

---

1	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		out.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

1	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		out.PAYINFO

Payment Offset.

---

1	enum    INV_TYPE	In Out

	Use		optional
	Parent		out.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT)
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

1	int    FLAGS	In Out

	Use		optional
	Parent		out.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

2	array    INV_INFO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

3	string    CITY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

3	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

3	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
2	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

3	string    INV_INSTR	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

3	enum    INV_TERMS	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

3	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

3	string    STATE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

3	string    ZIP	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

2	array    CC_INFO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address.

---

3	string    CITY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

3	string    DEBIT_EXP	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

3	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

3	string    SECURITY_ID	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

3	string    STATE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

3	string    ZIP	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

2	array    DD_INFO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

3	string    ADDRESS	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

3	string    BANK_NO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

3	string    CITY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

3	string    COUNTRY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

3	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

3	string    STATE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

3	enum    TYPE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

3	string    ZIP	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

2	array    SEPA_INFO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment menthod. There will be only one element and element id is not significant.

---

3	enum    MANDATE_TYPE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

3	string    IBAN	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

3	string    BIC	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

3	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

3	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

3	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

3	array    DEBTOR_INFO	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

4	string    CITY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

4	string    ZIP	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

4	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

4	string    REF_PARTY	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

4	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

3	string    CREDITOR_ID	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

3	string    CREDITOR_NAME	In Out

	Use		optional
	Parent		out.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

0	array    PROFILES	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Profile array to be associated with the account.

---

1	poid    PROFILE_OBJ	In Out

	Use		required
	Parent		out.PROFILES
	Class		/profile

The POID of profile object created or modified.

---

1	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.PROFILES
	Recursive		false

Inherited info for profile object.

---

0	array    TOPUP_INFO	In Out

	Use		optional
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Topup array.

---

1	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO
	Class		/topup

Topup poid.

---

1	poid    ACCOUNT_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO
	Class		/account

Account poid.

---

1	array    PAYINFO	In Out

	Use		required
	Parent		out.TOPUP_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		1

The elemid is significant. Contents are not significant. The element id points to the payinfo array element in the request to be used for top-up.

---

2	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

2	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

2	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO

Payment offset value.

---

2	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO

---

2	enum    INV_TYPE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

2	int    FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

2	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

3	array    INV_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

4	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

4	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

4	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

4	string    INV_INSTR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

4	enum    INV_TERMS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

4	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

4	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

3	array    CC_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

4	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

4	string    DEBIT_EXP	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

4	string    DEBIT_NUM	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

4	string    SECURITY_ID	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

4	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

4	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

3	array    DD_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

4	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

4	string    BANK_NO	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

4	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

4	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

4	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

4	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

4	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

4	enum    TYPE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

4	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

3	array    SEPA_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

4	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

4	string    IBAN	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

4	string    BIC	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

4	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

4	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

4	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

4	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

4	array    DEBTOR_INFO	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

5	string    ADDRESS	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

5	string    CITY	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

5	string    COUNTRY	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

5	string    NAME	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

5	string    ZIP	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

5	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

5	string    REF_PARTY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

5	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

4	string    CREDITOR_ID	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

4	string    CREDITOR_NAME	In Out

	Use		required
	Parent		out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

1	array    BILLINFO	In Out

	Use		required
	Parent		out.TOPUP_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		1

The elemid is significant. Contents are not significant. The element id points to the billinfo array element in the request to be used for top-up.

---

2	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO
	Mode		typeonly
	Class		/billinfo

The type only billinfo poid.

---

2	poid    BUSINESS_PROFILE_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO
	Class		/config/business_profile

Business profile poid. Pointer to the Business profile poid to which this billinfo belongs.

---

2	string    BILLINFO_ID	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO
	Max length		60

This field identifies the billinfo by name.

---

2	array    PAYINFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined

The Payinfo array. The element-id is significant, but not the contents. The element-id will be used to identify which payinfo array to use from the input. If it is not present then the payment method is considered either as transient or voucher.

---

3	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO
	Mode		typeonly
	Class		/payinfo

The partial poid of payinfo.

---

3	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018	Indicates SEPA payment type(PIN_PAY_TYPE_SEPA).

This represents the type of billing for user.

---

3	enum    PAYMENT_TERM	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

Payment term ID defines which payment term will be used in the payment due date calculation.

---

3	int    PAYMENT_OFFSET	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

Payment offset value.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

---

3	enum    INV_TYPE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

0x01	Indicates detail invoice(PIN_INV_TYPE_DETAIL).
0x02	Indicates summary invoice(PIN_INV_TYPE_SUMMARY).
0x04	Indicates regular invoice(PIN_INV_TYPE_REGULAR).
0x08	Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE).
0x10	Indicates parent invoice(PIN_INV_TYPE_PARENT).
0x18	Indicates parent with subordinates invoice (PIN_INV_TYPE_PARENT_WITH_SUBORDS).
0x20	Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY).
0x40	Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE).

Indicates the type of invoice to be generated.

---

3	int    FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO

Partial Flag. This enables the operation to treat some fields from the request as optional. Values are (0) mandatory, or (1) optional. The fields affected are: PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO, PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.

---

3	substruct    INHERITED_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO
	Recursive		false

All subclass fields for the payinfo object are included in this substruct. The subclass depends on the pay_type. If pay_type is invoice then this array element will have PIN_FLD_INV_INFO, etc.

---

4	array    INV_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to invoice type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Street address.

---

5	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Country.

---

5	string    DELIVERY_DESCR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Delivery mechanism.

---

5	enum    DELIVERY_PREFER	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

0	Indicates email delivery(PIN_INV_EMAIL_DELIVERY).
1	Indicates mail delivery(PIN_INV_USP_DELIVERY).
3	Indicates fax delivery(PIN_INV_FAX_DELIVERY).

Prefered delivery method email(0), postal(1) and fax(3).

---

5	string    INV_INSTR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		1023

Comments to appear on each invoice.

---

5	enum    INV_TERMS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO

Used for invoice terms to be printed on the invoice.

---

5	string    EMAIL_ADDR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Email address to which invoice be delivered.

---

5	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		255

Name of party responsible for payment.

---

5	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.INV_INFO
	Max length		60

Zip/Postal code.

---

4	array    CC_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to credit card type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Street Address

---

5	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Country.

---

5	string    DEBIT_EXP	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		128

Credit card expiration date (mmyy).

---

5	string    DEBIT_NUM	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Credit card number.

---

5	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		255

Name as it appears on the credit card.

---

5	string    SECURITY_ID	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		30

Security ID. Used for credit card fraud prevention. This field stores the 3 digit CVV2 for Visa and 4 digit CID for amex.

---

5	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		90

State or province.

---

5	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.CC_INFO
	Max length		60

Zip/Postal code.

---

4	array    DD_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to direct debit type of payment menthod. There will be only one element and element id is not significant.

---

5	string    ADDRESS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Street Address.

---

5	string    BANK_NO	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		30

RDFI/Bank ID used for routing transactions.

---

5	string    CITY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

City.

---

5	string    COUNTRY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Country.

---

5	string    DEBIT_NUM	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Customer's bank account number.

---

5	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		255

Name as it appears on the card.

---

5	string    STATE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		90

State or province.

---

5	enum    TYPE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO

1	Checking Account type(PIN_ACCOUNT_TYPE_CHECKING).
2	Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS).
3	Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE).

Bank account type. Checking(1), savings(2) or corporate(3).

---

5	string    ZIP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.DD_INFO
	Max length		60

Zip/Postal code.

---

4	array    SEPA_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

This array element has fields related to SEPA type of payment method. There will be only one element and element id is not significant.

---

5	enum    MANDATE_TYPE	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

0	One-off mandate.
1	Recurring mandate.

Mandate type whether it is one-off or recurring.

---

5	string    IBAN	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		34

International Bank Account Number which is a unique identifier for the bank account.

---

5	string    BIC	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		11

Bank Identifier Code which is a unique identifier for the bank related to the account.

---

5	string    MANDATE_CONTRACT_ID	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

ID of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_CONTRACT_DESCR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Description of the underlying contract between the debtor and the creditor.

---

5	string    MANDATE_UNIQUE_REFERENCE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

A unique reference number for the mandate.

---

5	timestamp    MANDATE_SIGNED_T	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO

Date when the mandate is signed. This cannot be before the account creation date or a future date.

---

5	string    MANDATE_SIGNED_PLACE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		35

Place where the mandate is signed.

---

5	array    DEBTOR_INFO	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1
	Max ID		0
	Allowed Elem ID List		0
	Allow ELEMID_ASSIGN		false
	Allow ELEMID_ANY		false
	Recursive		false

Array to store SEPA compliant customer's bank account details.

---

6	string    ADDRESS	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Street address of the contact.

---

6	string    CITY	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		90

City portion of the address.

---

6	string    COUNTRY	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Country portion of the address.

---

6	string    NAME	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the contact.

---

6	string    ZIP	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		60

Zipcode.

---

6	string    IDENTIFICATION_CODE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Debtor identification code.

---

6	string    REF_PARTY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Name of the Debtor Reference Party.

---

6	string    REF_PARTY_ID_CODE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO.DEBTOR_INFO
	Max length		255

Identification code of the Debtor Reference Party.

---

5	string    CREDITOR_ID	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Identification code of the Creditor.

---

5	string    CREDITOR_NAME	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO
	Max length		255

Name of the Creditor.

---

2	array    BAL_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0
	Max number of Elements		1

The balance group info array. The element-id is significant, but not the contents. The element-id will be used to identify which balance group array to use from the input. If it is not present then a default balance group will be created for the billinfo.

---

3	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	Mode		typeonly
	Class		/balance_group

The partial poid of the balance group to be created. During monitor creation/update, Poid type of /balance_group/monitor is used.

---

3	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	Max length		255

Balance Group name.

---

3	array    BILLINFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		key
	Iteration		undefined
	Min number of Elements		0

The billinfo array element. Here the contents are not significant. The element id will determine the billinfo that will be associated with this balance group. if not specified then the first billinfo that the system finds will be associated with this balance group.

---

3	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	Class		/billinfo

The POID of Billinfo that this balance group will be associated with. The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ will be ignored.

---

3	array    LIMIT	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This an optional array to set the credit limit parameters. The element id is significant and indicates the resource id for which the limit is being set.

---

4	decimal    CREDIT_LIMIT	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

4	decimal    CREDIT_FLOOR	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Baseline for calculating percentage for threshold triggers. Credit limit minus credit floor is 100% of measured range. Credit floor does NOT enforce any limit on current balance.

---

4	decimal    CREDIT_THRESHOLDS_FIXED	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Limit for this resource. Current balance cannot exceed this limit unless affected by a limit override rate or manually adjusted by a CSR.

---

4	int    CREDIT_THRESHOLDS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT

Bit flags for triggering when resource balance crosses a boundary when increasing in value.

---

4	array    THRESHOLDS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT
	ElemID mode		ignored
	Iteration		undefined
	Allow ELEMID_ASSIGN		true
	Allow ELEMID_ANY		true
	Recursive		false

Array of fixed threshold values.

---

5	int    THRESHOLD	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value.

---

5	decimal    AMOUNT	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.LIMIT.THRESHOLDS

Fixed threshold value in Decimal data type

---

3	array    RULES	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO
	ElemID mode		index
	Iteration		undefined
	Min number of Elements		0

This is an optional array to set the consumption rules for a resource. The element id is significant and indicates a resource id for which the limit as well as consumption rules are set.

---

4	enum    CONSUMPTION_RULE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO.BAL_INFO.RULES

0	The consumption rule is not defined (PIN_CONSUMPTION_RULE_UNDEFINED).
1	Earliest start time. Consume the sub-balance with the earliest validity start time (earliest valid_from) first (PIN_CONSUMPTION_RULE_EST).
2	Latest start time. Consume the sub-balance with the latest validity start time (latest valid_from) first (PIN_CONSUMPTION_RULE_LST).
3	Earliest expiration time. Consume the sub-balance that expires first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET)
4	Latest expiration time. Consume the sub-balance that expires last (latest valid_to.)(PIN_CONSUMPTION_RULE_LET)
5	Earliest start time and latest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET).
6	Earliest start time and earliest expiration time. Consume the sub-balance with the earliest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET).
7	Latest start time and earliest expiration time. Consume the sub-balance with the latest sub-balance first. If more than one sub-balances has the same valid_from, consume the one with the earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
8	Latest start time and latest expiration time. Consume the sub-balance with the latest valid_from first. If more than one sub-balances has the same valid_from, consume the one with the latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET).
9	Earliest expiration time and earliest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST).
10	Earliest expiration time and latest start time. Consume the sub-balance with the earliest valid_to first. If more than one sub-balances has the same valid_to, consume the one with the latest valid_from first(PIN_CONSUMPTION_RULE_EETLST).
11	Latest expiration time and earliest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the earliest valid_from first(PIN_CONSUMPTION_RULE_LETEST).
12	Latest expiration time and latest start time. Consume the sub-balance with the latest valid_to first. If more than one sub-balances has the same valid_to, use the one with the latest valid_from first(PIN_CONSUMPTION_RULE_LETLST).

Consumption rule to be applied on the resource.

---

2	enum    PAY_TYPE	In Out

	Use		required
	Parent		out.TOPUP_INFO.BILLINFO

10001	Indicates invoice type(PIN_PAY_TYPE_INVOICE).
10003	Indicates credit card type(PIN_PAY_TYPE_CC).
10005	Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD).
10007	Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD).
10018
10101	.

This represents the type of billing for user.

---

2	int    PARENT_FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

This flag indicates if this billinfo has subordinates or not. A value of 0 indicates no subordinates and a value of 1 indicates that it has subordinates.

---

2	int    BILL_WHEN	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

Anniversary billing slot.

---

2	int    ACTG_FUTURE_DOM	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

New Accounting Close day-of-month (1-31).

---

2	enum    ACTG_TYPE	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

1	This represents "open items" type of accounting. With open item accounting customer's bill does not include amounts from previous bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS).
2	This represents "balance forward" type of accounting. With balance forward accounting customer's bill will include amounts from previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD).

Accounting type of the billinfo. Possible values are PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This field is used to allocate items for payment. If not specified, the configuration entry actg_type is read from pin.conf of CM. If CM's pin.conf does not have actg_type entry active, then default accounting type will be balance forward type.

---

2	enum    BILLING_STATUS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

0	Indicates billing status is active(PIN_BILL_ACTIVE).
1	Indicates billing status is inactive(PIN_BILL_INACTIVE).

Indicates whether the billinfo should be billed or it should be suspended for billing.

---

2	int    BILLING_STATUS_FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given billing status.

---

2	enum    STATUS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

10100	Indicates an active billinfo(PIN_STATUS_ACTIVE).
10102	Indicates an inactive billinfo(PIN_STATUS_INACTIVE).
10103	Indicates a closed billinfo(PIN_STATUS_CLOSED).

Status of the billinfo: active, inactive, or closed.

---

2	int    STATUS_FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

Indicates a reason for setting of the given status.

---

2	int    SPONSOR_FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsoree.

---

2	int    SPONSOREE_FLAGS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

It indicates whether this billinfo has a sponsor.

---

2	poid    AR_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO
	Class		/billinfo

It indicates the AR billinfo for the given billinfo. It can be present only for a subodinate billinfo.

---

2	poid    PARENT_BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO
	Class		/billinfo

It indicates the immediate (one level up) parent. Note that the given billinfo is not necessarily a subordinate. The parent field may reflect just child-parent relation. It should be mandatory if moving to the new parent.

---

2	int    CURRENCY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	int    CURRENCY_SECONDARY	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

During account creation these values will be derived from the account. In future when an account can have multiple currencies, the value specified here will be used.

---

2	enum    BILLING_SEGMENT	In Out

	Use		optional
	Parent		out.TOPUP_INFO.BILLINFO

It indicates the Billing Segment. A billing segment is a user defined category such as wholesale or retail, that controls the accounting DOMs to which a bill unit can be assigned.

---

1	poid    PAYINFO_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO
	Class		/payinfo

The payinfo object that this topup is associated with. If PIN_FLD_PAYINFO is passed in, this field will be ignored. If PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.

---

1	poid    BILLINFO_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO
	Class		/billinfo

The POID of Billinfo that this topup is associated with. If PIN_FLD_BILLINFO is passed in, this field will be ignored. If PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.

---

1	decimal    TOPUP_AMT	In Out

	Use		required
	Parent		out.TOPUP_INFO

Topup amount. In case of auto-topups this will indicate the amount to topup with.

---

1	decimal    TOPUP_CAP	In Out

	Use		optional
	Parent		out.TOPUP_INFO

Topup cap. This amount indicates the max topup that can be done for a given cycle. The cycle is driven by the cycle information set-up in the billinfo. A values of 0 means no cap.

---

1	decimal    CYCLE_TOPPED_AMT	In Out

	Use		optional
	Parent		out.TOPUP_INFO

This indicates the total topped up amount during the given cycle. This amount will be populated only if the cap is set.

---

1	timestamp    LAST_TOPUP_T	In Out

	Use		optional
	Parent		out.TOPUP_INFO

This indicates the when the last topup happened.

---

1	array    GROUP_TOPUP_INFO	In Out

	Use		optional
	Parent		out.TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

The field represents sponsored topup. The array contains fields related to Sponsored topup only.

---

2	poid    POID	In Out

	Use		required
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/group/topup

The /group/topup poid. Poid of sponsored topup group involved in the creation/modification of member account.

---

2	poid    PARENT	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/account

Parent's account poid

---

2	string    NAME	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	Max length		255

The Name of the /group/topup. This helps to identify the group.

---

2	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	Class		/balance_group

Balance Group of the parent/payer of the /group/topup

---

2	array    GROUP_TOPUP_LIMITS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Represents /group/topup financial properties per resource id.

---

3	int    RESOURCE_ID	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Resource id of topup operation.

---

3	decimal    TOPUP_AMT	In Out

	Use		required
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup amount is used in automatic sponsored topup.

---

3	decimal    TOPUP_CAP	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_LIMITS

Topup cap is used as a maximum limit of topup for particular topup group during cycle.

---

2	array    GROUP_TOPUP_MEMBERS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO
	ElemID mode		ignored
	Iteration		undefined
	Min number of Elements		0

Represents members' properties of the /group/topup.

---

3	poid    BAL_GRP_OBJ	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
	Class		/balance_group

Balance Group of a member of the /group/topup.

---

3	int    TOPUP_INTERVAL	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

This indicates the interval at which automatic sponsored topup occur.

---

3	string    PIN	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS
	Max length		60

The PIN which will be used for authentication during Ad-Hoc topup.

---

3	enum    STATUS	In Out

	Use		optional
	Parent		out.TOPUP_INFO.GROUP_TOPUP_INFO.GROUP_TOPUP_MEMBERS

10100	Indicates an active member(PIN_STATUS_ACTIVE).
10102	Indicates an inactive member(PIN_STATUS_INACTIVE).
10103	Indicates a closed member(PIN_STATUS_CLOSED).

The status of the member (active/inactive/closed).

---

0	substruct    CONTEXT_INFO	In Out

	Use		optional

Substruct to pass information from external clients.

---

1	string    CORRELATION_ID	In Out

	Use		optional
	Parent		out.CONTEXT_INFO
	Max length		128

Correlation id passed by an external system to Oracle Monetization Cloud.

---

1	string    EXTERNAL_USER	In Out

	Use		optional
	Parent		out.CONTEXT_INFO
	Max length		128

User of an external system connecting to Oracle Monetization Cloud.

---

---

Input index	Input details	Output index	Output details